3 Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2007, 2008, 2009, 2010
4 Free Software Foundation, Inc.
6 This file is part of GDB.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 #include "exceptions.h"
23 #include "arch-utils.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 */
30 #include "gdb_string.h"
31 #include "gdb_vfork.h"
33 #include "expression.h"
37 #include "filenames.h" /* for DOSish file names */
41 #include "tracepoint.h"
46 #include "cli/cli-decode.h"
47 #include "cli/cli-script.h"
48 #include "cli/cli-setshow.h"
49 #include "cli/cli-cmds.h"
51 #include "python/python.h"
54 #include "tui/tui.h" /* For tui_active et.al. */
59 /* Prototypes for local command functions */
61 static void complete_command (char *, int);
63 static void echo_command (char *, int);
65 static void pwd_command (char *, int);
67 static void show_version (char *, int);
69 static void help_command (char *, int);
71 static void show_command (char *, int);
73 static void info_command (char *, int);
75 static void show_debug (char *, int);
77 static void set_debug (char *, int);
79 static void show_user (char *, int);
81 static void make_command (char *, int);
83 static void shell_escape (char *, int);
85 static void edit_command (char *, int);
87 static void list_command (char *, int);
89 void apropos_command (char *, int);
91 /* Prototypes for local utility functions */
93 static void ambiguous_line_spec (struct symtabs_and_lines *);
95 /* Limit the call depth of user-defined commands */
96 int max_user_call_depth;
98 /* Define all cmd_list_elements. */
100 /* Chain containing all defined commands. */
102 struct cmd_list_element *cmdlist;
104 /* Chain containing all defined info subcommands. */
106 struct cmd_list_element *infolist;
108 /* Chain containing all defined enable subcommands. */
110 struct cmd_list_element *enablelist;
112 /* Chain containing all defined disable subcommands. */
114 struct cmd_list_element *disablelist;
116 /* Chain containing all defined toggle subcommands. */
118 struct cmd_list_element *togglelist;
120 /* Chain containing all defined stop subcommands. */
122 struct cmd_list_element *stoplist;
124 /* Chain containing all defined delete subcommands. */
126 struct cmd_list_element *deletelist;
128 /* Chain containing all defined detach subcommands. */
130 struct cmd_list_element *detachlist;
132 /* Chain containing all defined kill subcommands. */
134 struct cmd_list_element *killlist;
136 /* Chain containing all defined "enable breakpoint" subcommands. */
138 struct cmd_list_element *enablebreaklist;
140 /* Chain containing all defined set subcommands */
142 struct cmd_list_element *setlist;
144 /* Chain containing all defined unset subcommands */
146 struct cmd_list_element *unsetlist;
148 /* Chain containing all defined show subcommands. */
150 struct cmd_list_element *showlist;
152 /* Chain containing all defined \"set history\". */
154 struct cmd_list_element *sethistlist;
156 /* Chain containing all defined \"show history\". */
158 struct cmd_list_element *showhistlist;
160 /* Chain containing all defined \"unset history\". */
162 struct cmd_list_element *unsethistlist;
164 /* Chain containing all defined maintenance subcommands. */
166 struct cmd_list_element *maintenancelist;
168 /* Chain containing all defined "maintenance info" subcommands. */
170 struct cmd_list_element *maintenanceinfolist;
172 /* Chain containing all defined "maintenance print" subcommands. */
174 struct cmd_list_element *maintenanceprintlist;
176 struct cmd_list_element *setprintlist;
178 struct cmd_list_element *showprintlist;
180 struct cmd_list_element *setdebuglist;
182 struct cmd_list_element *showdebuglist;
184 struct cmd_list_element *setchecklist;
186 struct cmd_list_element *showchecklist;
188 /* Command tracing state. */
190 int source_verbose = 0;
191 int trace_commands = 0;
193 /* 'script-extension' option support. */
195 static const char script_ext_off[] = "off";
196 static const char script_ext_soft[] = "soft";
197 static const char script_ext_strict[] = "strict";
199 static const char *script_ext_enums[] = {
206 static const char *script_ext_mode = script_ext_soft;
208 /* Utility used everywhere when at least one argument is needed and
212 error_no_arg (char *why)
214 error (_("Argument required (%s)."), why);
217 /* The "info" command is defined as a prefix, with allow_unknown = 0.
218 Therefore, its own definition is called only for "info" with no args. */
221 info_command (char *arg, int from_tty)
223 printf_unfiltered (_("\"info\" must be followed by the name of an info command.\n"));
224 help_list (infolist, "info ", -1, gdb_stdout);
227 /* The "show" command with no arguments shows all the settings. */
230 show_command (char *arg, int from_tty)
232 cmd_show_list (showlist, from_tty, "");
235 /* Provide documentation on command or list given by COMMAND. FROM_TTY
239 help_command (char *command, int from_tty)
241 help_cmd (command, gdb_stdout);
244 /* String compare function for qsort. */
246 compare_strings (const void *arg1, const void *arg2)
248 const char **s1 = (const char **) arg1;
249 const char **s2 = (const char **) arg2;
250 return strcmp (*s1, *s2);
253 /* The "complete" command is used by Emacs to implement completion. */
256 complete_command (char *arg, int from_tty)
260 char **completions, *point, *arg_prefix;
266 argpoint = strlen (arg);
268 /* complete_line assumes that its first argument is somewhere within,
269 and except for filenames at the beginning of, the word to be completed.
270 The following crude imitation of readline's word-breaking tries to
272 point = arg + argpoint;
275 if (strchr (rl_completer_word_break_characters, point[-1]) != 0)
280 arg_prefix = alloca (point - arg + 1);
281 memcpy (arg_prefix, arg, point - arg);
282 arg_prefix[point - arg] = 0;
284 completions = complete_line (point, arg, argpoint);
290 for (size = 0; completions[size]; ++size)
292 qsort (completions, size, sizeof (char *), compare_strings);
294 /* We do extra processing here since we only want to print each
300 printf_unfiltered ("%s%s\n", arg_prefix, completions[item]);
301 next_item = item + 1;
302 while (next_item < size
303 && ! strcmp (completions[item], completions[next_item]))
305 xfree (completions[next_item]);
309 xfree (completions[item]);
318 is_complete_command (struct cmd_list_element *c)
320 return cmd_cfunc_eq (c, complete_command);
324 show_version (char *args, int from_tty)
327 print_gdb_version (gdb_stdout);
328 printf_filtered ("\n");
332 /* Handle the quit command. */
335 quit_command (char *args, int from_tty)
337 if (!quit_confirm ())
338 error (_("Not confirmed."));
340 disconnect_tracing (from_tty);
342 quit_force (args, from_tty);
346 pwd_command (char *args, int from_tty)
349 error (_("The \"pwd\" command does not take an argument: %s"), args);
350 if (! getcwd (gdb_dirbuf, sizeof (gdb_dirbuf)))
351 error (_("Error finding name of working directory: %s"),
352 safe_strerror (errno));
354 if (strcmp (gdb_dirbuf, current_directory) != 0)
355 printf_unfiltered (_("Working directory %s\n (canonically %s).\n"),
356 current_directory, gdb_dirbuf);
358 printf_unfiltered (_("Working directory %s.\n"), current_directory);
362 cd_command (char *dir, int from_tty)
365 /* Found something other than leading repetitions of "/..". */
369 /* If the new directory is absolute, repeat is a no-op; if relative,
370 repeat might be useful but is more likely to be a mistake. */
374 error_no_arg (_("new working directory"));
376 dir = tilde_expand (dir);
377 make_cleanup (xfree, dir);
380 perror_with_name (dir);
382 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
383 /* There's too much mess with DOSish names like "d:", "d:.",
384 "d:./foo" etc. Instead of having lots of special #ifdef'ed code,
385 simply get the canonicalized name of the current directory. */
386 dir = getcwd (gdb_dirbuf, sizeof (gdb_dirbuf));
390 if (IS_DIR_SEPARATOR (dir[len - 1]))
392 /* Remove the trailing slash unless this is a root directory
393 (including a drive letter on non-Unix systems). */
394 if (!(len == 1) /* "/" */
395 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
396 && !(len == 3 && dir[1] == ':') /* "d:/" */
402 dir = savestring (dir, len);
403 if (IS_ABSOLUTE_PATH (dir))
404 current_directory = dir;
407 if (IS_DIR_SEPARATOR (current_directory[strlen (current_directory) - 1]))
408 current_directory = concat (current_directory, dir, (char *)NULL);
410 current_directory = concat (current_directory, SLASH_STRING,
415 /* Now simplify any occurrences of `.' and `..' in the pathname. */
418 for (p = current_directory; *p;)
420 if (IS_DIR_SEPARATOR (p[0]) && p[1] == '.'
421 && (p[2] == 0 || IS_DIR_SEPARATOR (p[2])))
423 else if (IS_DIR_SEPARATOR (p[0]) && p[1] == '.' && p[2] == '.'
424 && (p[3] == 0 || IS_DIR_SEPARATOR (p[3])))
428 /* Search backwards for the directory just before the "/.."
429 and obliterate it and the "/..". */
431 while (q != current_directory && !IS_DIR_SEPARATOR (q[-1]))
434 if (q == current_directory)
435 /* current_directory is
436 a relative pathname ("can't happen"--leave it alone). */
440 strcpy (q - 1, p + 3);
445 /* We are dealing with leading repetitions of "/..", for example
446 "/../..", which is the Mach super-root. */
456 forget_cached_source_info ();
459 pwd_command ((char *) 0, 1);
462 /* Show the current value of the 'script-extension' option. */
465 show_script_ext_mode (struct ui_file *file, int from_tty,
466 struct cmd_list_element *c, const char *value)
468 fprintf_filtered (file, _("\
469 Script filename extension recognition is \"%s\".\n"),
473 /* Try to open SCRIPT_FILE.
474 If successful, the full path name is stored in *FULL_PATHP,
475 the stream is stored in *STREAMP, and return 1.
476 The caller is responsible for freeing *FULL_PATHP.
477 If not successful, return 0; errno is set for the last file
480 If SEARCH_PATH is non-zero, and the file isn't found in cwd,
481 search for it in the source search path.
483 NOTE: This calls openp which uses xfullpath to compute the full path
484 instead of gdb_realpath. Symbolic links are not resolved. */
487 find_and_open_script (const char *script_file, int search_path,
488 FILE **streamp, char **full_pathp)
492 struct cleanup *old_cleanups;
493 int search_flags = OPF_TRY_CWD_FIRST;
495 file = tilde_expand (script_file);
496 old_cleanups = make_cleanup (xfree, file);
499 search_flags |= OPF_SEARCH_IN_PATH;
501 /* Search for and open 'file' on the search path used for source
502 files. Put the full location in *FULL_PATHP. */
503 fd = openp (source_path, search_flags,
504 file, O_RDONLY, full_pathp);
508 int save_errno = errno;
509 do_cleanups (old_cleanups);
514 do_cleanups (old_cleanups);
516 *streamp = fdopen (fd, FOPEN_RT);
520 /* Load script FILE, which has already been opened as STREAM.
521 STREAM is closed before we return. */
524 source_script_from_stream (FILE *stream, const char *file)
526 if (script_ext_mode != script_ext_off
527 && strlen (file) > 3 && !strcmp (&file[strlen (file) - 3], ".py"))
529 volatile struct gdb_exception e;
531 TRY_CATCH (e, RETURN_MASK_ERROR)
533 source_python_script (stream, file);
537 /* Should we fallback to ye olde GDB script mode? */
538 if (script_ext_mode == script_ext_soft
539 && e.reason == RETURN_ERROR && e.error == UNSUPPORTED_ERROR)
541 fseek (stream, 0, SEEK_SET);
542 script_from_file (stream, (char*) file);
546 /* Nope, just punt. */
555 script_from_file (stream, file);
558 /* Worker to perform the "source" command.
560 If SEARCH_PATH is non-zero, and the file isn't found in cwd,
561 search for it in the source search path. */
564 source_script_with_search (const char *file, int from_tty, int search_path)
568 struct cleanup *old_cleanups;
570 if (file == NULL || *file == 0)
571 error (_("source command requires file name of file to source."));
573 if (!find_and_open_script (file, search_path, &stream, &full_path))
575 /* The script wasn't found, or was otherwise inaccessible.
576 If the source command was invoked interactively, throw an error.
577 Otherwise (e.g. if it was invoked by a script), silently ignore
580 perror_with_name (file);
585 old_cleanups = make_cleanup (xfree, full_path);
586 source_script_from_stream (stream, file);
587 do_cleanups (old_cleanups);
590 /* Wrapper around source_script_with_search to export it to main.c
591 for use in loading .gdbinit scripts. */
594 source_script (char *file, int from_tty)
596 source_script_with_search (file, from_tty, 0);
599 /* Return the source_verbose global variable to its previous state
600 on exit from the source command, by whatever means. */
602 source_verbose_cleanup (void *old_value)
604 source_verbose = *(int *)old_value;
609 source_command (char *args, int from_tty)
611 struct cleanup *old_cleanups;
613 int *old_source_verbose = xmalloc (sizeof(int));
616 *old_source_verbose = source_verbose;
617 old_cleanups = make_cleanup (source_verbose_cleanup, old_source_verbose);
619 /* -v causes the source command to run in verbose mode.
620 -s causes the file to be searched in the source search path,
621 even if the file name contains a '/'.
622 We still have to be able to handle filenames with spaces in a
623 backward compatible way, so buildargv is not appropriate. */
627 while (args[0] != '\0')
629 /* Make sure leading white space does not break the comparisons. */
630 while (isspace(args[0]))
636 if (args[1] == 'v' && isspace (args[2]))
640 /* Skip passed -v. */
643 else if (args[1] == 's' && isspace (args[2]))
647 /* Skip passed -s. */
654 while (isspace (args[0]))
659 source_script_with_search (file, from_tty, search_path);
661 do_cleanups (old_cleanups);
666 echo_command (char *text, int from_tty)
672 while ((c = *p++) != '\0')
676 /* \ at end of argument is used after spaces
677 so they won't be lost. */
681 c = parse_escape (get_current_arch (), &p);
683 printf_filtered ("%c", c);
686 printf_filtered ("%c", c);
689 /* Force this output to appear now. */
691 gdb_flush (gdb_stdout);
695 shell_escape (char *arg, int from_tty)
697 #if defined(CANT_FORK) || \
698 (!defined(HAVE_WORKING_VFORK) && !defined(HAVE_WORKING_FORK))
699 /* If ARG is NULL, they want an inferior shell, but `system' just
700 reports if the shell is available when passed a NULL arg. */
701 int rc = system (arg ? arg : "");
704 arg = "inferior shell";
708 fprintf_unfiltered (gdb_stderr, "Cannot execute %s: %s\n", arg,
709 safe_strerror (errno));
710 gdb_flush (gdb_stderr);
714 fprintf_unfiltered (gdb_stderr, "%s exited with status %d\n", arg, rc);
715 gdb_flush (gdb_stderr);
718 /* Make sure to return to the directory GDB thinks it is, in case the
719 shell command we just ran changed it. */
720 chdir (current_directory);
722 #else /* Can fork. */
725 if ((pid = vfork ()) == 0)
727 char *p, *user_shell;
729 if ((user_shell = (char *) getenv ("SHELL")) == NULL)
730 user_shell = "/bin/sh";
732 /* Get the name of the shell for arg0 */
733 if ((p = strrchr (user_shell, '/')) == NULL)
736 p++; /* Get past '/' */
739 execl (user_shell, p, (char *) 0);
741 execl (user_shell, p, "-c", arg, (char *) 0);
743 fprintf_unfiltered (gdb_stderr, "Cannot execute %s: %s\n", user_shell,
744 safe_strerror (errno));
745 gdb_flush (gdb_stderr);
750 while ((rc = wait (&status)) != pid && rc != -1)
753 error (_("Fork failed"));
754 #endif /* Can fork. */
758 edit_command (char *arg, int from_tty)
760 struct symtabs_and_lines sals;
761 struct symtab_and_line sal;
767 /* Pull in the current default source line if necessary. */
770 set_default_source_symtab_and_line ();
771 sal = get_current_source_symtab_and_line ();
774 /* bare "edit" edits file with present line. */
779 error (_("No default source file yet."));
780 sal.line += get_lines_to_list () / 2;
785 /* Now should only be one argument -- decode it in SAL. */
788 sals = decode_line_1 (&arg1, 0, 0, 0, 0, 0);
797 ambiguous_line_spec (&sals);
806 error (_("Junk at end of line specification."));
808 /* If line was specified by address,
809 first print exactly which line, and which file.
810 In this case, sal.symtab == 0 means address is outside
811 of all known source files, not that user failed to give a filename. */
814 struct gdbarch *gdbarch;
816 /* FIXME-32x64--assumes sal.pc fits in long. */
817 error (_("No source file for address %s."),
818 hex_string ((unsigned long) sal.pc));
820 gdbarch = get_objfile_arch (sal.symtab->objfile);
821 sym = find_pc_function (sal.pc);
823 printf_filtered ("%s is in %s (%s:%d).\n",
824 paddress (gdbarch, sal.pc),
825 SYMBOL_PRINT_NAME (sym),
826 sal.symtab->filename, sal.line);
828 printf_filtered ("%s is at %s:%d.\n",
829 paddress (gdbarch, sal.pc),
830 sal.symtab->filename, sal.line);
833 /* If what was given does not imply a symtab, it must be an undebuggable
834 symbol which means no source code. */
837 error (_("No line number known for %s."), arg);
840 if ((editor = (char *) getenv ("EDITOR")) == NULL)
843 /* If we don't already know the full absolute file name of the
844 source file, find it now. */
845 if (!sal.symtab->fullname)
847 fn = symtab_to_fullname (sal.symtab);
852 fn = sal.symtab->fullname;
854 /* Quote the file name, in case it has whitespace or other special
856 p = xstrprintf ("%s +%d \"%s\"", editor, sal.line, fn);
857 shell_escape (p, from_tty);
862 list_command (char *arg, int from_tty)
864 struct symtabs_and_lines sals, sals_end;
865 struct symtab_and_line sal = { 0 };
866 struct symtab_and_line sal_end = { 0 };
867 struct symtab_and_line cursal = { 0 };
876 /* Pull in the current default source line if necessary */
877 if (arg == 0 || arg[0] == '+' || arg[0] == '-')
879 set_default_source_symtab_and_line ();
880 cursal = get_current_source_symtab_and_line ();
883 /* "l" or "l +" lists next ten lines. */
885 if (arg == 0 || strcmp (arg, "+") == 0)
887 print_source_lines (cursal.symtab, cursal.line,
888 cursal.line + get_lines_to_list (), 0);
892 /* "l -" lists previous ten lines, the ones before the ten just listed. */
893 if (strcmp (arg, "-") == 0)
895 print_source_lines (cursal.symtab,
896 max (get_first_line_listed () - get_lines_to_list (), 1),
897 get_first_line_listed (), 0);
901 /* Now if there is only one argument, decode it in SAL
903 If there are two arguments, decode them in SAL and SAL_END
904 and clear NO_END; however, if one of the arguments is blank,
905 set DUMMY_BEG or DUMMY_END to record that fact. */
907 if (!have_full_symbols () && !have_partial_symbols ())
908 error (_("No symbol table is loaded. Use the \"file\" command."));
915 sals = decode_line_1 (&arg1, 0, 0, 0, 0, 0);
921 ambiguous_line_spec (&sals);
930 /* Record whether the BEG arg is all digits. */
932 for (p = arg; p != arg1 && *p >= '0' && *p <= '9'; p++);
933 linenum_beg = (p == arg1);
935 while (*arg1 == ' ' || *arg1 == '\t')
941 while (*arg1 == ' ' || *arg1 == '\t')
948 sals_end = decode_line_1 (&arg1, 0, 0, 0, 0, 0);
950 sals_end = decode_line_1 (&arg1, 0, sal.symtab, sal.line, 0, 0);
951 if (sals_end.nelts == 0)
953 if (sals_end.nelts > 1)
955 ambiguous_line_spec (&sals_end);
956 xfree (sals_end.sals);
959 sal_end = sals_end.sals[0];
960 xfree (sals_end.sals);
965 error (_("Junk at end of line specification."));
967 if (!no_end && !dummy_beg && !dummy_end
968 && sal.symtab != sal_end.symtab)
969 error (_("Specified start and end are in different files."));
970 if (dummy_beg && dummy_end)
971 error (_("Two empty args do not say what lines to list."));
973 /* if line was specified by address,
974 first print exactly which line, and which file.
975 In this case, sal.symtab == 0 means address is outside
976 of all known source files, not that user failed to give a filename. */
979 struct gdbarch *gdbarch;
981 /* FIXME-32x64--assumes sal.pc fits in long. */
982 error (_("No source file for address %s."),
983 hex_string ((unsigned long) sal.pc));
985 gdbarch = get_objfile_arch (sal.symtab->objfile);
986 sym = find_pc_function (sal.pc);
988 printf_filtered ("%s is in %s (%s:%d).\n",
989 paddress (gdbarch, sal.pc),
990 SYMBOL_PRINT_NAME (sym),
991 sal.symtab->filename, sal.line);
993 printf_filtered ("%s is at %s:%d.\n",
994 paddress (gdbarch, sal.pc),
995 sal.symtab->filename, sal.line);
998 /* If line was not specified by just a line number,
999 and it does not imply a symtab, it must be an undebuggable symbol
1000 which means no source code. */
1002 if (!linenum_beg && sal.symtab == 0)
1003 error (_("No line number known for %s."), arg);
1005 /* If this command is repeated with RET,
1006 turn it into the no-arg variant. */
1011 if (dummy_beg && sal_end.symtab == 0)
1012 error (_("No default source file yet. Do \"help list\"."));
1014 print_source_lines (sal_end.symtab,
1015 max (sal_end.line - (get_lines_to_list () - 1), 1),
1016 sal_end.line + 1, 0);
1017 else if (sal.symtab == 0)
1018 error (_("No default source file yet. Do \"help list\"."));
1021 int first_line = sal.line - get_lines_to_list () / 2;
1023 if (first_line < 1) first_line = 1;
1025 print_source_lines (sal.symtab,
1027 first_line + get_lines_to_list (),
1031 print_source_lines (sal.symtab, sal.line,
1033 ? sal.line + get_lines_to_list ()
1034 : sal_end.line + 1),
1038 /* Subroutine of disassemble_command to simplify it.
1039 Perform the disassembly.
1040 NAME is the name of the function if known, or NULL.
1041 [LOW,HIGH) are the range of addresses to disassemble.
1042 MIXED is non-zero to print source with the assembler. */
1045 print_disassembly (struct gdbarch *gdbarch, const char *name,
1046 CORE_ADDR low, CORE_ADDR high, int flags)
1049 if (!tui_is_window_visible (DISASSEM_WIN))
1052 printf_filtered ("Dump of assembler code ");
1054 printf_filtered ("for function %s:\n", name);
1056 printf_filtered ("from %s to %s:\n",
1057 paddress (gdbarch, low), paddress (gdbarch, high));
1059 /* Dump the specified range. */
1060 gdb_disassembly (gdbarch, uiout, 0, flags, -1, low, high);
1062 printf_filtered ("End of assembler dump.\n");
1063 gdb_flush (gdb_stdout);
1068 tui_show_assembly (gdbarch, low);
1073 /* Subroutine of disassemble_command to simplify it.
1074 Print a disassembly of the current function according to FLAGS. */
1077 disassemble_current_function (int flags)
1079 struct frame_info *frame;
1080 struct gdbarch *gdbarch;
1081 CORE_ADDR low, high, pc;
1084 frame = get_selected_frame (_("No frame selected."));
1085 gdbarch = get_frame_arch (frame);
1086 pc = get_frame_pc (frame);
1087 if (find_pc_partial_function (pc, &name, &low, &high) == 0)
1088 error (_("No function contains program counter for selected frame."));
1090 /* NOTE: cagney/2003-02-13 The `tui_active' was previously
1093 /* FIXME: cagney/2004-02-07: This should be an observer. */
1094 low = tui_get_low_disassembly_address (gdbarch, low, pc);
1096 low += gdbarch_deprecated_function_start_offset (gdbarch);
1098 print_disassembly (gdbarch, name, low, high, flags);
1101 /* Dump a specified section of assembly code.
1105 - dump the assembly code for the function of the current pc
1106 disassemble [/mr] addr
1107 - dump the assembly code for the function at ADDR
1108 disassemble [/mr] low high
1109 - dump the assembly code in the range [LOW,HIGH)
1111 A /m modifier will include source code with the assembly.
1112 A /r modifier will include raw instructions in hex with the assembly. */
1115 disassemble_command (char *arg, int from_tty)
1117 struct gdbarch *gdbarch = get_current_arch ();
1118 CORE_ADDR low, high;
1120 CORE_ADDR pc, pc_masked;
1126 if (arg && *arg == '/')
1131 error (_("Missing modifier."));
1133 while (*arg && ! isspace (*arg))
1138 flags |= DISASSEMBLY_SOURCE;
1141 flags |= DISASSEMBLY_RAW_INSN;
1144 error (_("Invalid disassembly modifier."));
1148 while (isspace (*arg))
1152 if (! arg || ! *arg)
1154 flags |= DISASSEMBLY_OMIT_FNAME;
1155 disassemble_current_function (flags);
1159 pc = value_as_address (parse_to_comma_and_eval (&arg));
1165 if (find_pc_partial_function (pc, &name, &low, &high) == 0)
1166 error (_("No function contains specified address."));
1168 /* NOTE: cagney/2003-02-13 The `tui_active' was previously
1171 /* FIXME: cagney/2004-02-07: This should be an observer. */
1172 low = tui_get_low_disassembly_address (gdbarch, low, pc);
1174 low += gdbarch_deprecated_function_start_offset (gdbarch);
1175 flags |= DISASSEMBLY_OMIT_FNAME;
1179 /* Two arguments. */
1181 high = parse_and_eval_address (arg);
1184 print_disassembly (gdbarch, name, low, high, flags);
1188 make_command (char *arg, int from_tty)
1196 p = xmalloc (sizeof ("make ") + strlen (arg));
1197 strcpy (p, "make ");
1198 strcpy (p + sizeof ("make ") - 1, arg);
1201 shell_escape (p, from_tty);
1205 show_user (char *args, int from_tty)
1207 struct cmd_list_element *c;
1208 extern struct cmd_list_element *cmdlist;
1212 char *comname = args;
1213 c = lookup_cmd (&comname, cmdlist, "", 0, 1);
1214 if (c->class != class_user)
1215 error (_("Not a user command."));
1216 show_user_1 (c, "", args, gdb_stdout);
1220 for (c = cmdlist; c; c = c->next)
1222 if (c->class == class_user || c->prefixlist != NULL)
1223 show_user_1 (c, "", c->name, gdb_stdout);
1228 /* Search through names of commands and documentations for a certain
1232 apropos_command (char *searchstr, int from_tty)
1234 extern struct cmd_list_element *cmdlist; /*This is the main command list*/
1236 char *pattern_fastmap;
1237 char errorbuffer[512];
1238 pattern_fastmap = xcalloc (256, sizeof (char));
1239 if (searchstr == NULL)
1240 error (_("REGEXP string is empty"));
1242 if (regcomp(&pattern,searchstr,REG_ICASE) == 0)
1244 pattern.fastmap=pattern_fastmap;
1245 re_compile_fastmap(&pattern);
1246 apropos_cmd (gdb_stdout,cmdlist,&pattern,"");
1250 regerror(regcomp(&pattern,searchstr,REG_ICASE),NULL,errorbuffer,512);
1251 error (_("Error in regular expression:%s"),errorbuffer);
1253 xfree (pattern_fastmap);
1256 /* Print a list of files and line numbers which a user may choose from
1257 in order to list a function which was specified ambiguously (as with
1258 `list classname::overloadedfuncname', for example). The vector in
1259 SALS provides the filenames and line numbers. */
1262 ambiguous_line_spec (struct symtabs_and_lines *sals)
1266 for (i = 0; i < sals->nelts; ++i)
1267 printf_filtered (_("file: \"%s\", line number: %d\n"),
1268 sals->sals[i].symtab->filename, sals->sals[i].line);
1272 set_debug (char *arg, int from_tty)
1274 printf_unfiltered (_("\"set debug\" must be followed by the name of a debug subcommand.\n"));
1275 help_list (setdebuglist, "set debug ", -1, gdb_stdout);
1279 show_debug (char *args, int from_tty)
1281 cmd_show_list (showdebuglist, from_tty, "");
1285 init_cmd_lists (void)
1287 max_user_call_depth = 1024;
1297 enablebreaklist = NULL;
1302 showhistlist = NULL;
1303 unsethistlist = NULL;
1304 maintenancelist = NULL;
1305 maintenanceinfolist = NULL;
1306 maintenanceprintlist = NULL;
1307 setprintlist = NULL;
1308 showprintlist = NULL;
1309 setchecklist = NULL;
1310 showchecklist = NULL;
1314 show_info_verbose (struct ui_file *file, int from_tty,
1315 struct cmd_list_element *c,
1319 fprintf_filtered (file, _("\
1320 Verbose printing of informational messages is %s.\n"), value);
1322 fprintf_filtered (file, _("Verbosity is %s.\n"), value);
1326 show_history_expansion_p (struct ui_file *file, int from_tty,
1327 struct cmd_list_element *c, const char *value)
1329 fprintf_filtered (file, _("History expansion on command input is %s.\n"),
1334 show_baud_rate (struct ui_file *file, int from_tty,
1335 struct cmd_list_element *c, const char *value)
1337 fprintf_filtered (file, _("Baud rate for remote serial I/O is %s.\n"),
1342 show_remote_debug (struct ui_file *file, int from_tty,
1343 struct cmd_list_element *c, const char *value)
1345 fprintf_filtered (file, _("Debugging of remote protocol is %s.\n"),
1350 show_remote_timeout (struct ui_file *file, int from_tty,
1351 struct cmd_list_element *c, const char *value)
1353 fprintf_filtered (file, _("\
1354 Timeout limit to wait for target to respond is %s.\n"),
1359 show_max_user_call_depth (struct ui_file *file, int from_tty,
1360 struct cmd_list_element *c, const char *value)
1362 fprintf_filtered (file, _("\
1363 The max call depth for user-defined commands is %s.\n"),
1369 init_cli_cmds (void)
1371 struct cmd_list_element *c;
1372 char *source_help_text;
1374 /* Define the classes of commands.
1375 They will appear in the help list in the reverse of this order. */
1377 add_cmd ("internals", class_maintenance, NULL, _("\
1378 Maintenance commands.\n\
1379 Some gdb commands are provided just for use by gdb maintainers.\n\
1380 These commands are subject to frequent change, and may not be as\n\
1381 well documented as user commands."),
1383 add_cmd ("obscure", class_obscure, NULL, _("Obscure features."), &cmdlist);
1384 add_cmd ("aliases", class_alias, NULL, _("Aliases of other commands."), &cmdlist);
1385 add_cmd ("user-defined", class_user, NULL, _("\
1386 User-defined commands.\n\
1387 The commands in this class are those defined by the user.\n\
1388 Use the \"define\" command to define a command."), &cmdlist);
1389 add_cmd ("support", class_support, NULL, _("Support facilities."), &cmdlist);
1391 add_cmd ("status", class_info, NULL, _("Status inquiries."), &cmdlist);
1392 add_cmd ("files", class_files, NULL, _("Specifying and examining files."),
1394 add_cmd ("breakpoints", class_breakpoint, NULL,
1395 _("Making program stop at certain points."), &cmdlist);
1396 add_cmd ("data", class_vars, NULL, _("Examining data."), &cmdlist);
1397 add_cmd ("stack", class_stack, NULL, _("\
1398 Examining the stack.\n\
1399 The stack is made up of stack frames. Gdb assigns numbers to stack frames\n\
1400 counting from zero for the innermost (currently executing) frame.\n\n\
1401 At any time gdb identifies one frame as the \"selected\" frame.\n\
1402 Variable lookups are done with respect to the selected frame.\n\
1403 When the program being debugged stops, gdb selects the innermost frame.\n\
1404 The commands below can be used to select other frames by number or address."),
1406 add_cmd ("running", class_run, NULL, _("Running the program."), &cmdlist);
1408 /* Define general commands. */
1410 add_com ("pwd", class_files, pwd_command, _("\
1411 Print working directory. This is used for your program as well."));
1413 c = add_cmd ("cd", class_files, cd_command, _("\
1414 Set working directory to DIR for debugger and program being debugged.\n\
1415 The change does not take effect for the program being debugged\n\
1416 until the next time it is started."), &cmdlist);
1417 set_cmd_completer (c, filename_completer);
1419 add_com ("echo", class_support, echo_command, _("\
1420 Print a constant string. Give string as argument.\n\
1421 C escape sequences may be used in the argument.\n\
1422 No newline is added at the end of the argument;\n\
1423 use \"\\n\" if you want a newline to be printed.\n\
1424 Since leading and trailing whitespace are ignored in command arguments,\n\
1425 if you want to print some you must use \"\\\" before leading whitespace\n\
1426 to be printed or after trailing whitespace."));
1427 add_com ("document", class_support, document_command, _("\
1428 Document a user-defined command.\n\
1429 Give command name as argument. Give documentation on following lines.\n\
1430 End with a line of just \"end\"."));
1431 add_com ("define", class_support, define_command, _("\
1432 Define a new command name. Command name is argument.\n\
1433 Definition appears on following lines, one command per line.\n\
1434 End with a line of just \"end\".\n\
1435 Use the \"document\" command to give documentation for the new command.\n\
1436 Commands defined in this way may have up to ten arguments."));
1438 source_help_text = xstrprintf (_("\
1439 Read commands from a file named FILE.\n\
1441 Usage: source [-s] [-v] FILE\n\
1442 -s: search for the script in the source search path,\n\
1443 even if FILE contains directories.\n\
1444 -v: each command in FILE is echoed as it is executed.\n\
1446 Note that the file \"%s\" is read automatically in this way\n\
1447 when GDB is started."), gdbinit);
1448 c = add_cmd ("source", class_support, source_command,
1449 source_help_text, &cmdlist);
1450 set_cmd_completer (c, filename_completer);
1452 add_setshow_enum_cmd ("script-extension", class_support,
1453 script_ext_enums, &script_ext_mode, _("\
1454 Set mode for script filename extension recognition."), _("\
1455 Show mode for script filename extension recognition."), _("\
1456 off == no filename extension recognition (all sourced files are GDB scripts)\n\
1457 soft == evaluate script according to filename extension, fallback to GDB script"
1459 strict == evaluate script according to filename extension, error if not supported"
1462 show_script_ext_mode,
1463 &setlist, &showlist);
1465 add_com ("quit", class_support, quit_command, _("Exit gdb."));
1466 c = add_com ("help", class_support, help_command,
1467 _("Print list of commands."));
1468 set_cmd_completer (c, command_completer);
1469 add_com_alias ("q", "quit", class_support, 1);
1470 add_com_alias ("h", "help", class_support, 1);
1472 add_setshow_boolean_cmd ("verbose", class_support, &info_verbose, _("\
1473 Set verbosity."), _("\
1474 Show verbosity."), NULL,
1477 &setlist, &showlist);
1479 add_prefix_cmd ("history", class_support, set_history,
1480 _("Generic command for setting command history parameters."),
1481 &sethistlist, "set history ", 0, &setlist);
1482 add_prefix_cmd ("history", class_support, show_history,
1483 _("Generic command for showing command history parameters."),
1484 &showhistlist, "show history ", 0, &showlist);
1486 add_setshow_boolean_cmd ("expansion", no_class, &history_expansion_p, _("\
1487 Set history expansion on command input."), _("\
1488 Show history expansion on command input."), _("\
1489 Without an argument, history expansion is enabled."),
1491 show_history_expansion_p,
1492 &sethistlist, &showhistlist);
1494 add_prefix_cmd ("info", class_info, info_command, _("\
1495 Generic command for showing things about the program being debugged."),
1496 &infolist, "info ", 0, &cmdlist);
1497 add_com_alias ("i", "info", class_info, 1);
1498 add_com_alias ("inf", "info", class_info, 1);
1500 add_com ("complete", class_obscure, complete_command,
1501 _("List the completions for the rest of the line as a command."));
1503 add_prefix_cmd ("show", class_info, show_command, _("\
1504 Generic command for showing things about the debugger."),
1505 &showlist, "show ", 0, &cmdlist);
1506 /* Another way to get at the same thing. */
1507 add_info ("set", show_command, _("Show all GDB settings."));
1509 add_cmd ("commands", no_class, show_commands, _("\
1510 Show the history of commands you typed.\n\
1511 You can supply a command number to start with, or a `+' to start after\n\
1512 the previous command number shown."),
1515 add_cmd ("version", no_class, show_version,
1516 _("Show what version of GDB this is."), &showlist);
1518 add_com ("while", class_support, while_command, _("\
1519 Execute nested commands WHILE the conditional expression is non zero.\n\
1520 The conditional expression must follow the word `while' and must in turn be\n\
1521 followed by a new line. The nested commands must be entered one per line,\n\
1522 and should be terminated by the word `end'."));
1524 add_com ("if", class_support, if_command, _("\
1525 Execute nested commands once IF the conditional expression is non zero.\n\
1526 The conditional expression must follow the word `if' and must in turn be\n\
1527 followed by a new line. The nested commands must be entered one per line,\n\
1528 and should be terminated by the word 'else' or `end'. If an else clause\n\
1529 is used, the same rules apply to its nested commands as to the first ones."));
1531 /* If target is open when baud changes, it doesn't take effect until the
1532 next open (I think, not sure). */
1533 add_setshow_zinteger_cmd ("remotebaud", no_class, &baud_rate, _("\
1534 Set baud rate for remote serial I/O."), _("\
1535 Show baud rate for remote serial I/O."), _("\
1536 This value is used to set the speed of the serial port when debugging\n\
1537 using remote targets."),
1540 &setlist, &showlist);
1542 add_setshow_zinteger_cmd ("remote", no_class, &remote_debug, _("\
1543 Set debugging of remote protocol."), _("\
1544 Show debugging of remote protocol."), _("\
1545 When enabled, each packet sent or received with the remote target\n\
1549 &setdebuglist, &showdebuglist);
1551 add_setshow_integer_cmd ("remotetimeout", no_class, &remote_timeout, _("\
1552 Set timeout limit to wait for target to respond."), _("\
1553 Show timeout limit to wait for target to respond."), _("\
1554 This value is used to set the time limit for gdb to wait for a response\n\
1557 show_remote_timeout,
1558 &setlist, &showlist);
1560 add_prefix_cmd ("debug", no_class, set_debug,
1561 _("Generic command for setting gdb debugging flags"),
1562 &setdebuglist, "set debug ", 0, &setlist);
1564 add_prefix_cmd ("debug", no_class, show_debug,
1565 _("Generic command for showing gdb debugging flags"),
1566 &showdebuglist, "show debug ", 0, &showlist);
1568 c = add_com ("shell", class_support, shell_escape, _("\
1569 Execute the rest of the line as a shell command.\n\
1570 With no arguments, run an inferior shell."));
1571 set_cmd_completer (c, filename_completer);
1573 c = add_com ("edit", class_files, edit_command, _("\
1574 Edit specified file or function.\n\
1575 With no argument, edits file containing most recent line listed.\n\
1576 Editing targets can be specified in these ways:\n\
1577 FILE:LINENUM, to edit at that line in that file,\n\
1578 FUNCTION, to edit at the beginning of that function,\n\
1579 FILE:FUNCTION, to distinguish among like-named static functions.\n\
1580 *ADDRESS, to edit at the line containing that address.\n\
1581 Uses EDITOR environment variable contents as editor (or ex as default)."));
1583 c->completer = location_completer;
1585 add_com ("list", class_files, list_command, _("\
1586 List specified function or line.\n\
1587 With no argument, lists ten more lines after or around previous listing.\n\
1588 \"list -\" lists the ten lines before a previous ten-line listing.\n\
1589 One argument specifies a line, and ten lines are listed around that line.\n\
1590 Two arguments with comma between specify starting and ending lines to list.\n\
1591 Lines can be specified in these ways:\n\
1592 LINENUM, to list around that line in current file,\n\
1593 FILE:LINENUM, to list around that line in that file,\n\
1594 FUNCTION, to list around beginning of that function,\n\
1595 FILE:FUNCTION, to distinguish among like-named static functions.\n\
1596 *ADDRESS, to list around the line containing that address.\n\
1597 With two args if one is empty it stands for ten lines away from the other arg."));
1600 add_com_alias ("l", "list", class_files, 1);
1602 add_com_alias ("v", "list", class_files, 1);
1605 add_com_alias ("file", "list", class_files, 1);
1607 c = add_com ("disassemble", class_vars, disassemble_command, _("\
1608 Disassemble a specified section of memory.\n\
1609 Default is the function surrounding the pc of the selected frame.\n\
1610 With a /m modifier, source lines are included (if available).\n\
1611 With a /r modifier, raw instructions in hex are included.\n\
1612 With a single argument, the function surrounding that address is dumped.\n\
1613 Two arguments (separated by a comma) are taken as a range of memory to dump."));
1614 set_cmd_completer (c, location_completer);
1616 add_com_alias ("va", "disassemble", class_xdb, 0);
1618 /* NOTE: cagney/2000-03-20: Being able to enter ``(gdb) !ls'' would
1619 be a really useful feature. Unfortunately, the below wont do
1620 this. Instead it adds support for the form ``(gdb) ! ls''
1621 (i.e. the space is required). If the ``!'' command below is
1622 added the complains about no ``!'' command would be replaced by
1623 complains about how the ``!'' command is broken :-) */
1625 add_com_alias ("!", "shell", class_support, 0);
1627 c = add_com ("make", class_support, make_command, _("\
1628 Run the ``make'' program using the rest of the line as arguments."));
1629 set_cmd_completer (c, filename_completer);
1630 add_cmd ("user", no_class, show_user, _("\
1631 Show definitions of user defined commands.\n\
1632 Argument is the name of the user defined command.\n\
1633 With no argument, show definitions of all user defined commands."), &showlist);
1634 add_com ("apropos", class_support, apropos_command,
1635 _("Search for commands matching a REGEXP"));
1637 add_setshow_integer_cmd ("max-user-call-depth", no_class,
1638 &max_user_call_depth, _("\
1639 Set the max call depth for user-defined commands."), _("\
1640 Show the max call depth for user-defined commands."), NULL,
1642 show_max_user_call_depth,
1643 &setlist, &showlist);
1645 add_setshow_boolean_cmd ("trace-commands", no_class, &trace_commands, _("\
1646 Set tracing of GDB CLI commands."), _("\
1647 Show state of GDB CLI command tracing."), _("\
1648 When 'on', each command is displayed as it is executed."),
1651 &setlist, &showlist);