3 Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2007, 2008, 2009, 2010,
4 2011 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
222 info_command (char *arg, int from_tty)
224 printf_unfiltered (_("\"info\" must be followed by "
225 "the name of an info command.\n"));
226 help_list (infolist, "info ", -1, gdb_stdout);
229 /* The "show" command with no arguments shows all the settings. */
232 show_command (char *arg, int from_tty)
234 cmd_show_list (showlist, from_tty, "");
237 /* Provide documentation on command or list given by COMMAND. FROM_TTY
241 help_command (char *command, int from_tty)
243 help_cmd (command, gdb_stdout);
246 /* String compare function for qsort. */
248 compare_strings (const void *arg1, const void *arg2)
250 const char **s1 = (const char **) arg1;
251 const char **s2 = (const char **) arg2;
253 return strcmp (*s1, *s2);
256 /* The "complete" command is used by Emacs to implement completion. */
259 complete_command (char *arg, int from_tty)
262 char **completions, *point, *arg_prefix;
268 argpoint = strlen (arg);
270 /* complete_line assumes that its first argument is somewhere
271 within, and except for filenames at the beginning of, the word to
272 be completed. The following crude imitation of readline's
273 word-breaking tries to accomodate this. */
274 point = arg + argpoint;
277 if (strchr (rl_completer_word_break_characters, point[-1]) != 0)
282 arg_prefix = alloca (point - arg + 1);
283 memcpy (arg_prefix, arg, point - arg);
284 arg_prefix[point - arg] = 0;
286 completions = complete_line (point, arg, argpoint);
292 for (size = 0; completions[size]; ++size)
294 qsort (completions, size, sizeof (char *), compare_strings);
296 /* We do extra processing here since we only want to print each
303 printf_unfiltered ("%s%s\n", arg_prefix, completions[item]);
304 next_item = item + 1;
305 while (next_item < size
306 && ! strcmp (completions[item], completions[next_item]))
308 xfree (completions[next_item]);
312 xfree (completions[item]);
321 is_complete_command (struct cmd_list_element *c)
323 return cmd_cfunc_eq (c, complete_command);
327 show_version (char *args, int from_tty)
330 print_gdb_version (gdb_stdout);
331 printf_filtered ("\n");
335 /* Handle the quit command. */
338 quit_command (char *args, int from_tty)
340 if (!quit_confirm ())
341 error (_("Not confirmed."));
343 disconnect_tracing (from_tty);
345 quit_force (args, from_tty);
349 pwd_command (char *args, int from_tty)
352 error (_("The \"pwd\" command does not take an argument: %s"), args);
353 if (! getcwd (gdb_dirbuf, sizeof (gdb_dirbuf)))
354 error (_("Error finding name of working directory: %s"),
355 safe_strerror (errno));
357 if (strcmp (gdb_dirbuf, current_directory) != 0)
358 printf_unfiltered (_("Working directory %s\n (canonically %s).\n"),
359 current_directory, gdb_dirbuf);
361 printf_unfiltered (_("Working directory %s.\n"), current_directory);
365 cd_command (char *dir, int from_tty)
368 /* Found something other than leading repetitions of "/..". */
372 /* If the new directory is absolute, repeat is a no-op; if relative,
373 repeat might be useful but is more likely to be a mistake. */
377 error_no_arg (_("new working directory"));
379 dir = tilde_expand (dir);
380 make_cleanup (xfree, dir);
383 perror_with_name (dir);
385 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
386 /* There's too much mess with DOSish names like "d:", "d:.",
387 "d:./foo" etc. Instead of having lots of special #ifdef'ed code,
388 simply get the canonicalized name of the current directory. */
389 dir = getcwd (gdb_dirbuf, sizeof (gdb_dirbuf));
393 if (IS_DIR_SEPARATOR (dir[len - 1]))
395 /* Remove the trailing slash unless this is a root directory
396 (including a drive letter on non-Unix systems). */
397 if (!(len == 1) /* "/" */
398 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
399 && !(len == 3 && dir[1] == ':') /* "d:/" */
405 dir = savestring (dir, len);
406 if (IS_ABSOLUTE_PATH (dir))
407 current_directory = dir;
410 if (IS_DIR_SEPARATOR (current_directory[strlen (current_directory) - 1]))
411 current_directory = concat (current_directory, dir, (char *)NULL);
413 current_directory = concat (current_directory, SLASH_STRING,
418 /* Now simplify any occurrences of `.' and `..' in the pathname. */
421 for (p = current_directory; *p;)
423 if (IS_DIR_SEPARATOR (p[0]) && p[1] == '.'
424 && (p[2] == 0 || IS_DIR_SEPARATOR (p[2])))
426 else if (IS_DIR_SEPARATOR (p[0]) && p[1] == '.' && p[2] == '.'
427 && (p[3] == 0 || IS_DIR_SEPARATOR (p[3])))
431 /* Search backwards for the directory just before the "/.."
432 and obliterate it and the "/..". */
435 while (q != current_directory && !IS_DIR_SEPARATOR (q[-1]))
438 if (q == current_directory)
439 /* current_directory is
440 a relative pathname ("can't happen"--leave it alone). */
444 strcpy (q - 1, p + 3);
449 /* We are dealing with leading repetitions of "/..", for
450 example "/../..", which is the Mach super-root. */
460 forget_cached_source_info ();
463 pwd_command ((char *) 0, 1);
466 /* Show the current value of the 'script-extension' option. */
469 show_script_ext_mode (struct ui_file *file, int from_tty,
470 struct cmd_list_element *c, const char *value)
472 fprintf_filtered (file,
473 _("Script filename extension recognition is \"%s\".\n"),
477 /* Try to open SCRIPT_FILE.
478 If successful, the full path name is stored in *FULL_PATHP,
479 the stream is stored in *STREAMP, and return 1.
480 The caller is responsible for freeing *FULL_PATHP.
481 If not successful, return 0; errno is set for the last file
484 If SEARCH_PATH is non-zero, and the file isn't found in cwd,
485 search for it in the source search path.
487 NOTE: This calls openp which uses xfullpath to compute the full path
488 instead of gdb_realpath. Symbolic links are not resolved. */
491 find_and_open_script (const char *script_file, int search_path,
492 FILE **streamp, char **full_pathp)
496 struct cleanup *old_cleanups;
497 int search_flags = OPF_TRY_CWD_FIRST;
499 file = tilde_expand (script_file);
500 old_cleanups = make_cleanup (xfree, file);
503 search_flags |= OPF_SEARCH_IN_PATH;
505 /* Search for and open 'file' on the search path used for source
506 files. Put the full location in *FULL_PATHP. */
507 fd = openp (source_path, search_flags,
508 file, O_RDONLY, full_pathp);
512 int save_errno = errno;
513 do_cleanups (old_cleanups);
518 do_cleanups (old_cleanups);
520 *streamp = fdopen (fd, FOPEN_RT);
524 /* Load script FILE, which has already been opened as STREAM.
525 STREAM is closed before we return. */
528 source_script_from_stream (FILE *stream, const char *file)
530 if (script_ext_mode != script_ext_off
531 && strlen (file) > 3 && !strcmp (&file[strlen (file) - 3], ".py"))
533 volatile struct gdb_exception e;
535 TRY_CATCH (e, RETURN_MASK_ERROR)
537 source_python_script (stream, file);
541 /* Should we fallback to ye olde GDB script mode? */
542 if (script_ext_mode == script_ext_soft
543 && e.reason == RETURN_ERROR && e.error == UNSUPPORTED_ERROR)
545 fseek (stream, 0, SEEK_SET);
546 script_from_file (stream, (char*) file);
550 /* Nope, just punt. */
559 script_from_file (stream, file);
562 /* Worker to perform the "source" command.
564 If SEARCH_PATH is non-zero, and the file isn't found in cwd,
565 search for it in the source search path. */
568 source_script_with_search (const char *file, int from_tty, int search_path)
572 struct cleanup *old_cleanups;
574 if (file == NULL || *file == 0)
575 error (_("source command requires file name of file to source."));
577 if (!find_and_open_script (file, search_path, &stream, &full_path))
579 /* The script wasn't found, or was otherwise inaccessible.
580 If the source command was invoked interactively, throw an
581 error. Otherwise (e.g. if it was invoked by a script),
582 silently ignore the error. */
584 perror_with_name (file);
589 old_cleanups = make_cleanup (xfree, full_path);
590 source_script_from_stream (stream, file);
591 do_cleanups (old_cleanups);
594 /* Wrapper around source_script_with_search to export it to main.c
595 for use in loading .gdbinit scripts. */
598 source_script (char *file, int from_tty)
600 source_script_with_search (file, from_tty, 0);
603 /* Return the source_verbose global variable to its previous state
604 on exit from the source command, by whatever means. */
606 source_verbose_cleanup (void *old_value)
608 source_verbose = *(int *)old_value;
613 source_command (char *args, int from_tty)
615 struct cleanup *old_cleanups;
617 int *old_source_verbose = xmalloc (sizeof(int));
620 *old_source_verbose = source_verbose;
621 old_cleanups = make_cleanup (source_verbose_cleanup,
624 /* -v causes the source command to run in verbose mode.
625 -s causes the file to be searched in the source search path,
626 even if the file name contains a '/'.
627 We still have to be able to handle filenames with spaces in a
628 backward compatible way, so buildargv is not appropriate. */
632 while (args[0] != '\0')
634 /* Make sure leading white space does not break the
636 while (isspace(args[0]))
642 if (args[1] == 'v' && isspace (args[2]))
646 /* Skip passed -v. */
649 else if (args[1] == 's' && isspace (args[2]))
653 /* Skip passed -s. */
660 while (isspace (args[0]))
665 source_script_with_search (file, from_tty, search_path);
667 do_cleanups (old_cleanups);
672 echo_command (char *text, int from_tty)
678 while ((c = *p++) != '\0')
682 /* \ at end of argument is used after spaces
683 so they won't be lost. */
687 c = parse_escape (get_current_arch (), &p);
689 printf_filtered ("%c", c);
692 printf_filtered ("%c", c);
695 /* Force this output to appear now. */
697 gdb_flush (gdb_stdout);
701 shell_escape (char *arg, int from_tty)
703 #if defined(CANT_FORK) || \
704 (!defined(HAVE_WORKING_VFORK) && !defined(HAVE_WORKING_FORK))
705 /* If ARG is NULL, they want an inferior shell, but `system' just
706 reports if the shell is available when passed a NULL arg. */
707 int rc = system (arg ? arg : "");
710 arg = "inferior shell";
714 fprintf_unfiltered (gdb_stderr, "Cannot execute %s: %s\n", arg,
715 safe_strerror (errno));
716 gdb_flush (gdb_stderr);
720 fprintf_unfiltered (gdb_stderr, "%s exited with status %d\n", arg, rc);
721 gdb_flush (gdb_stderr);
724 /* Make sure to return to the directory GDB thinks it is, in case
725 the shell command we just ran changed it. */
726 chdir (current_directory);
728 #else /* Can fork. */
731 if ((pid = vfork ()) == 0)
733 char *p, *user_shell;
735 if ((user_shell = (char *) getenv ("SHELL")) == NULL)
736 user_shell = "/bin/sh";
738 /* Get the name of the shell for arg0. */
739 if ((p = strrchr (user_shell, '/')) == NULL)
742 p++; /* Get past '/' */
745 execl (user_shell, p, (char *) 0);
747 execl (user_shell, p, "-c", arg, (char *) 0);
749 fprintf_unfiltered (gdb_stderr, "Cannot execute %s: %s\n", user_shell,
750 safe_strerror (errno));
751 gdb_flush (gdb_stderr);
756 while ((rc = wait (&status)) != pid && rc != -1)
759 error (_("Fork failed"));
760 #endif /* Can fork. */
764 edit_command (char *arg, int from_tty)
766 struct symtabs_and_lines sals;
767 struct symtab_and_line sal;
773 /* Pull in the current default source line if necessary. */
776 set_default_source_symtab_and_line ();
777 sal = get_current_source_symtab_and_line ();
780 /* Bare "edit" edits file with present line. */
785 error (_("No default source file yet."));
786 sal.line += get_lines_to_list () / 2;
790 /* Now should only be one argument -- decode it in SAL. */
793 sals = decode_line_1 (&arg1, 0, 0, 0, 0, 0);
802 ambiguous_line_spec (&sals);
811 error (_("Junk at end of line specification."));
813 /* If line was specified by address, first print exactly which
814 line, and which file. In this case, sal.symtab == 0 means
815 address is outside of all known source files, not that user
816 failed to give a filename. */
819 struct gdbarch *gdbarch;
822 /* FIXME-32x64--assumes sal.pc fits in long. */
823 error (_("No source file for address %s."),
824 hex_string ((unsigned long) sal.pc));
826 gdbarch = get_objfile_arch (sal.symtab->objfile);
827 sym = find_pc_function (sal.pc);
829 printf_filtered ("%s is in %s (%s:%d).\n",
830 paddress (gdbarch, sal.pc),
831 SYMBOL_PRINT_NAME (sym),
832 sal.symtab->filename, sal.line);
834 printf_filtered ("%s is at %s:%d.\n",
835 paddress (gdbarch, sal.pc),
836 sal.symtab->filename, sal.line);
839 /* If what was given does not imply a symtab, it must be an
840 undebuggable symbol which means no source code. */
843 error (_("No line number known for %s."), arg);
846 if ((editor = (char *) getenv ("EDITOR")) == NULL)
849 /* If we don't already know the full absolute file name of the
850 source file, find it now. */
851 if (!sal.symtab->fullname)
853 fn = symtab_to_fullname (sal.symtab);
858 fn = sal.symtab->fullname;
860 /* Quote the file name, in case it has whitespace or other special
862 p = xstrprintf ("%s +%d \"%s\"", editor, sal.line, fn);
863 shell_escape (p, from_tty);
868 list_command (char *arg, int from_tty)
870 struct symtabs_and_lines sals, sals_end;
871 struct symtab_and_line sal = { 0 };
872 struct symtab_and_line sal_end = { 0 };
873 struct symtab_and_line cursal = { 0 };
882 /* Pull in the current default source line if necessary. */
883 if (arg == 0 || arg[0] == '+' || arg[0] == '-')
885 set_default_source_symtab_and_line ();
886 cursal = get_current_source_symtab_and_line ();
889 /* "l" or "l +" lists next ten lines. */
891 if (arg == 0 || strcmp (arg, "+") == 0)
893 print_source_lines (cursal.symtab, cursal.line,
894 cursal.line + get_lines_to_list (), 0);
898 /* "l -" lists previous ten lines, the ones before the ten just
900 if (strcmp (arg, "-") == 0)
902 print_source_lines (cursal.symtab,
903 max (get_first_line_listed ()
904 - get_lines_to_list (), 1),
905 get_first_line_listed (), 0);
909 /* Now if there is only one argument, decode it in SAL
911 If there are two arguments, decode them in SAL and SAL_END
912 and clear NO_END; however, if one of the arguments is blank,
913 set DUMMY_BEG or DUMMY_END to record that fact. */
915 if (!have_full_symbols () && !have_partial_symbols ())
916 error (_("No symbol table is loaded. Use the \"file\" command."));
923 sals = decode_line_1 (&arg1, 0, 0, 0, 0, 0);
929 ambiguous_line_spec (&sals);
938 /* Record whether the BEG arg is all digits. */
940 for (p = arg; p != arg1 && *p >= '0' && *p <= '9'; p++);
941 linenum_beg = (p == arg1);
943 while (*arg1 == ' ' || *arg1 == '\t')
949 while (*arg1 == ' ' || *arg1 == '\t')
956 sals_end = decode_line_1 (&arg1, 0, 0, 0, 0, 0);
958 sals_end = decode_line_1 (&arg1, 0, sal.symtab, sal.line, 0, 0);
959 if (sals_end.nelts == 0)
961 if (sals_end.nelts > 1)
963 ambiguous_line_spec (&sals_end);
964 xfree (sals_end.sals);
967 sal_end = sals_end.sals[0];
968 xfree (sals_end.sals);
973 error (_("Junk at end of line specification."));
975 if (!no_end && !dummy_beg && !dummy_end
976 && sal.symtab != sal_end.symtab)
977 error (_("Specified start and end are in different files."));
978 if (dummy_beg && dummy_end)
979 error (_("Two empty args do not say what lines to list."));
981 /* If line was specified by address,
982 first print exactly which line, and which file.
984 In this case, sal.symtab == 0 means address is outside of all
985 known source files, not that user failed to give a filename. */
988 struct gdbarch *gdbarch;
991 /* FIXME-32x64--assumes sal.pc fits in long. */
992 error (_("No source file for address %s."),
993 hex_string ((unsigned long) sal.pc));
995 gdbarch = get_objfile_arch (sal.symtab->objfile);
996 sym = find_pc_function (sal.pc);
998 printf_filtered ("%s is in %s (%s:%d).\n",
999 paddress (gdbarch, sal.pc),
1000 SYMBOL_PRINT_NAME (sym),
1001 sal.symtab->filename, sal.line);
1003 printf_filtered ("%s is at %s:%d.\n",
1004 paddress (gdbarch, sal.pc),
1005 sal.symtab->filename, sal.line);
1008 /* If line was not specified by just a line number, and it does not
1009 imply a symtab, it must be an undebuggable symbol which means no
1012 if (!linenum_beg && sal.symtab == 0)
1013 error (_("No line number known for %s."), arg);
1015 /* If this command is repeated with RET,
1016 turn it into the no-arg variant. */
1021 if (dummy_beg && sal_end.symtab == 0)
1022 error (_("No default source file yet. Do \"help list\"."));
1024 print_source_lines (sal_end.symtab,
1025 max (sal_end.line - (get_lines_to_list () - 1), 1),
1026 sal_end.line + 1, 0);
1027 else if (sal.symtab == 0)
1028 error (_("No default source file yet. Do \"help list\"."));
1031 int first_line = sal.line - get_lines_to_list () / 2;
1033 if (first_line < 1) first_line = 1;
1035 print_source_lines (sal.symtab,
1037 first_line + get_lines_to_list (),
1041 print_source_lines (sal.symtab, sal.line,
1043 ? sal.line + get_lines_to_list ()
1044 : sal_end.line + 1),
1048 /* Subroutine of disassemble_command to simplify it.
1049 Perform the disassembly.
1050 NAME is the name of the function if known, or NULL.
1051 [LOW,HIGH) are the range of addresses to disassemble.
1052 MIXED is non-zero to print source with the assembler. */
1055 print_disassembly (struct gdbarch *gdbarch, const char *name,
1056 CORE_ADDR low, CORE_ADDR high, int flags)
1059 if (!tui_is_window_visible (DISASSEM_WIN))
1062 printf_filtered ("Dump of assembler code ");
1064 printf_filtered ("for function %s:\n", name);
1066 printf_filtered ("from %s to %s:\n",
1067 paddress (gdbarch, low), paddress (gdbarch, high));
1069 /* Dump the specified range. */
1070 gdb_disassembly (gdbarch, uiout, 0, flags, -1, low, high);
1072 printf_filtered ("End of assembler dump.\n");
1073 gdb_flush (gdb_stdout);
1078 tui_show_assembly (gdbarch, low);
1083 /* Subroutine of disassemble_command to simplify it.
1084 Print a disassembly of the current function according to FLAGS. */
1087 disassemble_current_function (int flags)
1089 struct frame_info *frame;
1090 struct gdbarch *gdbarch;
1091 CORE_ADDR low, high, pc;
1094 frame = get_selected_frame (_("No frame selected."));
1095 gdbarch = get_frame_arch (frame);
1096 pc = get_frame_pc (frame);
1097 if (find_pc_partial_function (pc, &name, &low, &high) == 0)
1098 error (_("No function contains program counter for selected frame."));
1100 /* NOTE: cagney/2003-02-13 The `tui_active' was previously
1103 /* FIXME: cagney/2004-02-07: This should be an observer. */
1104 low = tui_get_low_disassembly_address (gdbarch, low, pc);
1106 low += gdbarch_deprecated_function_start_offset (gdbarch);
1108 print_disassembly (gdbarch, name, low, high, flags);
1111 /* Dump a specified section of assembly code.
1115 - dump the assembly code for the function of the current pc
1116 disassemble [/mr] addr
1117 - dump the assembly code for the function at ADDR
1118 disassemble [/mr] low,high
1119 disassemble [/mr] low,+length
1120 - dump the assembly code in the range [LOW,HIGH), or [LOW,LOW+length)
1122 A /m modifier will include source code with the assembly.
1123 A /r modifier will include raw instructions in hex with the assembly. */
1126 disassemble_command (char *arg, int from_tty)
1128 struct gdbarch *gdbarch = get_current_arch ();
1129 CORE_ADDR low, high;
1137 if (arg && *arg == '/')
1142 error (_("Missing modifier."));
1144 while (*arg && ! isspace (*arg))
1149 flags |= DISASSEMBLY_SOURCE;
1152 flags |= DISASSEMBLY_RAW_INSN;
1155 error (_("Invalid disassembly modifier."));
1159 while (isspace (*arg))
1163 if (! arg || ! *arg)
1165 flags |= DISASSEMBLY_OMIT_FNAME;
1166 disassemble_current_function (flags);
1170 pc = value_as_address (parse_to_comma_and_eval (&arg));
1176 if (find_pc_partial_function (pc, &name, &low, &high) == 0)
1177 error (_("No function contains specified address."));
1179 /* NOTE: cagney/2003-02-13 The `tui_active' was previously
1182 /* FIXME: cagney/2004-02-07: This should be an observer. */
1183 low = tui_get_low_disassembly_address (gdbarch, low, pc);
1185 low += gdbarch_deprecated_function_start_offset (gdbarch);
1186 flags |= DISASSEMBLY_OMIT_FNAME;
1190 /* Two arguments. */
1193 while (isspace (*arg))
1200 high = parse_and_eval_address (arg);
1205 print_disassembly (gdbarch, name, low, high, flags);
1209 make_command (char *arg, int from_tty)
1217 p = xmalloc (sizeof ("make ") + strlen (arg));
1218 strcpy (p, "make ");
1219 strcpy (p + sizeof ("make ") - 1, arg);
1222 shell_escape (p, from_tty);
1226 show_user (char *args, int from_tty)
1228 struct cmd_list_element *c;
1229 extern struct cmd_list_element *cmdlist;
1233 char *comname = args;
1235 c = lookup_cmd (&comname, cmdlist, "", 0, 1);
1236 if (c->class != class_user)
1237 error (_("Not a user command."));
1238 show_user_1 (c, "", args, gdb_stdout);
1242 for (c = cmdlist; c; c = c->next)
1244 if (c->class == class_user || c->prefixlist != NULL)
1245 show_user_1 (c, "", c->name, gdb_stdout);
1250 /* Search through names of commands and documentations for a certain
1251 regular expression. */
1254 apropos_command (char *searchstr, int from_tty)
1257 char errorbuffer[512];
1259 if (searchstr == NULL)
1260 error (_("REGEXP string is empty"));
1262 if (regcomp (&pattern, searchstr, REG_ICASE) == 0)
1263 apropos_cmd (gdb_stdout, cmdlist, &pattern, "");
1266 regerror (regcomp (&pattern, searchstr, REG_ICASE), NULL,
1268 error (_("Error in regular expression: %s"), errorbuffer);
1272 /* Print a list of files and line numbers which a user may choose from
1273 in order to list a function which was specified ambiguously (as
1274 with `list classname::overloadedfuncname', for example). The
1275 vector in SALS provides the filenames and line numbers. */
1278 ambiguous_line_spec (struct symtabs_and_lines *sals)
1282 for (i = 0; i < sals->nelts; ++i)
1283 printf_filtered (_("file: \"%s\", line number: %d\n"),
1284 sals->sals[i].symtab->filename, sals->sals[i].line);
1288 set_debug (char *arg, int from_tty)
1290 printf_unfiltered (_("\"set debug\" must be followed by "
1291 "the name of a debug subcommand.\n"));
1292 help_list (setdebuglist, "set debug ", -1, gdb_stdout);
1296 show_debug (char *args, int from_tty)
1298 cmd_show_list (showdebuglist, from_tty, "");
1302 init_cmd_lists (void)
1304 max_user_call_depth = 1024;
1314 enablebreaklist = NULL;
1319 showhistlist = NULL;
1320 unsethistlist = NULL;
1321 maintenancelist = NULL;
1322 maintenanceinfolist = NULL;
1323 maintenanceprintlist = NULL;
1324 setprintlist = NULL;
1325 showprintlist = NULL;
1326 setchecklist = NULL;
1327 showchecklist = NULL;
1331 show_info_verbose (struct ui_file *file, int from_tty,
1332 struct cmd_list_element *c,
1336 fprintf_filtered (file,
1337 _("Verbose printing of informational messages is %s.\n"),
1340 fprintf_filtered (file, _("Verbosity is %s.\n"), value);
1344 show_history_expansion_p (struct ui_file *file, int from_tty,
1345 struct cmd_list_element *c, const char *value)
1347 fprintf_filtered (file, _("History expansion on command input is %s.\n"),
1352 show_baud_rate (struct ui_file *file, int from_tty,
1353 struct cmd_list_element *c, const char *value)
1355 fprintf_filtered (file, _("Baud rate for remote serial I/O is %s.\n"),
1360 show_remote_debug (struct ui_file *file, int from_tty,
1361 struct cmd_list_element *c, const char *value)
1363 fprintf_filtered (file, _("Debugging of remote protocol is %s.\n"),
1368 show_remote_timeout (struct ui_file *file, int from_tty,
1369 struct cmd_list_element *c, const char *value)
1371 fprintf_filtered (file,
1372 _("Timeout limit to wait for target to respond is %s.\n"),
1377 show_max_user_call_depth (struct ui_file *file, int from_tty,
1378 struct cmd_list_element *c, const char *value)
1380 fprintf_filtered (file,
1381 _("The max call depth for user-defined commands is %s.\n"),
1387 init_cli_cmds (void)
1389 struct cmd_list_element *c;
1390 char *source_help_text;
1392 /* Define the classes of commands.
1393 They will appear in the help list in the reverse of this order. */
1395 add_cmd ("internals", class_maintenance, NULL, _("\
1396 Maintenance commands.\n\
1397 Some gdb commands are provided just for use by gdb maintainers.\n\
1398 These commands are subject to frequent change, and may not be as\n\
1399 well documented as user commands."),
1401 add_cmd ("obscure", class_obscure, NULL, _("Obscure features."), &cmdlist);
1402 add_cmd ("aliases", class_alias, NULL,
1403 _("Aliases of other commands."), &cmdlist);
1404 add_cmd ("user-defined", class_user, NULL, _("\
1405 User-defined commands.\n\
1406 The commands in this class are those defined by the user.\n\
1407 Use the \"define\" command to define a command."), &cmdlist);
1408 add_cmd ("support", class_support, NULL, _("Support facilities."), &cmdlist);
1410 add_cmd ("status", class_info, NULL, _("Status inquiries."), &cmdlist);
1411 add_cmd ("files", class_files, NULL, _("Specifying and examining files."),
1413 add_cmd ("breakpoints", class_breakpoint, NULL,
1414 _("Making program stop at certain points."), &cmdlist);
1415 add_cmd ("data", class_vars, NULL, _("Examining data."), &cmdlist);
1416 add_cmd ("stack", class_stack, NULL, _("\
1417 Examining the stack.\n\
1418 The stack is made up of stack frames. Gdb assigns numbers to stack frames\n\
1419 counting from zero for the innermost (currently executing) frame.\n\n\
1420 At any time gdb identifies one frame as the \"selected\" frame.\n\
1421 Variable lookups are done with respect to the selected frame.\n\
1422 When the program being debugged stops, gdb selects the innermost frame.\n\
1423 The commands below can be used to select other frames by number or address."),
1425 add_cmd ("running", class_run, NULL, _("Running the program."), &cmdlist);
1427 /* Define general commands. */
1429 add_com ("pwd", class_files, pwd_command, _("\
1430 Print working directory. This is used for your program as well."));
1432 c = add_cmd ("cd", class_files, cd_command, _("\
1433 Set working directory to DIR for debugger and program being debugged.\n\
1434 The change does not take effect for the program being debugged\n\
1435 until the next time it is started."), &cmdlist);
1436 set_cmd_completer (c, filename_completer);
1438 add_com ("echo", class_support, echo_command, _("\
1439 Print a constant string. Give string as argument.\n\
1440 C escape sequences may be used in the argument.\n\
1441 No newline is added at the end of the argument;\n\
1442 use \"\\n\" if you want a newline to be printed.\n\
1443 Since leading and trailing whitespace are ignored in command arguments,\n\
1444 if you want to print some you must use \"\\\" before leading whitespace\n\
1445 to be printed or after trailing whitespace."));
1446 add_com ("document", class_support, document_command, _("\
1447 Document a user-defined command.\n\
1448 Give command name as argument. Give documentation on following lines.\n\
1449 End with a line of just \"end\"."));
1450 add_com ("define", class_support, define_command, _("\
1451 Define a new command name. Command name is argument.\n\
1452 Definition appears on following lines, one command per line.\n\
1453 End with a line of just \"end\".\n\
1454 Use the \"document\" command to give documentation for the new command.\n\
1455 Commands defined in this way may have up to ten arguments."));
1457 source_help_text = xstrprintf (_("\
1458 Read commands from a file named FILE.\n\
1460 Usage: source [-s] [-v] FILE\n\
1461 -s: search for the script in the source search path,\n\
1462 even if FILE contains directories.\n\
1463 -v: each command in FILE is echoed as it is executed.\n\
1465 Note that the file \"%s\" is read automatically in this way\n\
1466 when GDB is started."), gdbinit);
1467 c = add_cmd ("source", class_support, source_command,
1468 source_help_text, &cmdlist);
1469 set_cmd_completer (c, filename_completer);
1471 add_setshow_enum_cmd ("script-extension", class_support,
1472 script_ext_enums, &script_ext_mode, _("\
1473 Set mode for script filename extension recognition."), _("\
1474 Show mode for script filename extension recognition."), _("\
1475 off == no filename extension recognition (all sourced files are GDB scripts)\n\
1476 soft == evaluate script according to filename extension, fallback to GDB script"
1478 strict == evaluate script according to filename extension, error if not supported"
1481 show_script_ext_mode,
1482 &setlist, &showlist);
1484 add_com ("quit", class_support, quit_command, _("Exit gdb."));
1485 c = add_com ("help", class_support, help_command,
1486 _("Print list of commands."));
1487 set_cmd_completer (c, command_completer);
1488 add_com_alias ("q", "quit", class_support, 1);
1489 add_com_alias ("h", "help", class_support, 1);
1491 add_setshow_boolean_cmd ("verbose", class_support, &info_verbose, _("\
1492 Set verbosity."), _("\
1493 Show verbosity."), NULL,
1496 &setlist, &showlist);
1498 add_prefix_cmd ("history", class_support, set_history,
1499 _("Generic command for setting command history parameters."),
1500 &sethistlist, "set history ", 0, &setlist);
1501 add_prefix_cmd ("history", class_support, show_history,
1502 _("Generic command for showing command history parameters."),
1503 &showhistlist, "show history ", 0, &showlist);
1505 add_setshow_boolean_cmd ("expansion", no_class, &history_expansion_p, _("\
1506 Set history expansion on command input."), _("\
1507 Show history expansion on command input."), _("\
1508 Without an argument, history expansion is enabled."),
1510 show_history_expansion_p,
1511 &sethistlist, &showhistlist);
1513 add_prefix_cmd ("info", class_info, info_command, _("\
1514 Generic command for showing things about the program being debugged."),
1515 &infolist, "info ", 0, &cmdlist);
1516 add_com_alias ("i", "info", class_info, 1);
1517 add_com_alias ("inf", "info", class_info, 1);
1519 add_com ("complete", class_obscure, complete_command,
1520 _("List the completions for the rest of the line as a command."));
1522 add_prefix_cmd ("show", class_info, show_command, _("\
1523 Generic command for showing things about the debugger."),
1524 &showlist, "show ", 0, &cmdlist);
1525 /* Another way to get at the same thing. */
1526 add_info ("set", show_command, _("Show all GDB settings."));
1528 add_cmd ("commands", no_class, show_commands, _("\
1529 Show the history of commands you typed.\n\
1530 You can supply a command number to start with, or a `+' to start after\n\
1531 the previous command number shown."),
1534 add_cmd ("version", no_class, show_version,
1535 _("Show what version of GDB this is."), &showlist);
1537 add_com ("while", class_support, while_command, _("\
1538 Execute nested commands WHILE the conditional expression is non zero.\n\
1539 The conditional expression must follow the word `while' and must in turn be\n\
1540 followed by a new line. The nested commands must be entered one per line,\n\
1541 and should be terminated by the word `end'."));
1543 add_com ("if", class_support, if_command, _("\
1544 Execute nested commands once IF the conditional expression is non zero.\n\
1545 The conditional expression must follow the word `if' and must in turn be\n\
1546 followed by a new line. The nested commands must be entered one per line,\n\
1547 and should be terminated by the word 'else' or `end'. If an else clause\n\
1548 is used, the same rules apply to its nested commands as to the first ones."));
1550 /* If target is open when baud changes, it doesn't take effect until
1551 the next open (I think, not sure). */
1552 add_setshow_zinteger_cmd ("remotebaud", no_class, &baud_rate, _("\
1553 Set baud rate for remote serial I/O."), _("\
1554 Show baud rate for remote serial I/O."), _("\
1555 This value is used to set the speed of the serial port when debugging\n\
1556 using remote targets."),
1559 &setlist, &showlist);
1561 add_setshow_zinteger_cmd ("remote", no_class, &remote_debug, _("\
1562 Set debugging of remote protocol."), _("\
1563 Show debugging of remote protocol."), _("\
1564 When enabled, each packet sent or received with the remote target\n\
1568 &setdebuglist, &showdebuglist);
1570 add_setshow_integer_cmd ("remotetimeout", no_class, &remote_timeout, _("\
1571 Set timeout limit to wait for target to respond."), _("\
1572 Show timeout limit to wait for target to respond."), _("\
1573 This value is used to set the time limit for gdb to wait for a response\n\
1576 show_remote_timeout,
1577 &setlist, &showlist);
1579 add_prefix_cmd ("debug", no_class, set_debug,
1580 _("Generic command for setting gdb debugging flags"),
1581 &setdebuglist, "set debug ", 0, &setlist);
1583 add_prefix_cmd ("debug", no_class, show_debug,
1584 _("Generic command for showing gdb debugging flags"),
1585 &showdebuglist, "show debug ", 0, &showlist);
1587 c = add_com ("shell", class_support, shell_escape, _("\
1588 Execute the rest of the line as a shell command.\n\
1589 With no arguments, run an inferior shell."));
1590 set_cmd_completer (c, filename_completer);
1592 c = add_com ("edit", class_files, edit_command, _("\
1593 Edit specified file or function.\n\
1594 With no argument, edits file containing most recent line listed.\n\
1595 Editing targets can be specified in these ways:\n\
1596 FILE:LINENUM, to edit at that line in that file,\n\
1597 FUNCTION, to edit at the beginning of that function,\n\
1598 FILE:FUNCTION, to distinguish among like-named static functions.\n\
1599 *ADDRESS, to edit at the line containing that address.\n\
1600 Uses EDITOR environment variable contents as editor (or ex as default)."));
1602 c->completer = location_completer;
1604 add_com ("list", class_files, list_command, _("\
1605 List specified function or line.\n\
1606 With no argument, lists ten more lines after or around previous listing.\n\
1607 \"list -\" lists the ten lines before a previous ten-line listing.\n\
1608 One argument specifies a line, and ten lines are listed around that line.\n\
1609 Two arguments with comma between specify starting and ending lines to list.\n\
1610 Lines can be specified in these ways:\n\
1611 LINENUM, to list around that line in current file,\n\
1612 FILE:LINENUM, to list around that line in that file,\n\
1613 FUNCTION, to list around beginning of that function,\n\
1614 FILE:FUNCTION, to distinguish among like-named static functions.\n\
1615 *ADDRESS, to list around the line containing that address.\n\
1616 With two args if one is empty it stands for ten lines away from \
1620 add_com_alias ("l", "list", class_files, 1);
1622 add_com_alias ("v", "list", class_files, 1);
1625 add_com_alias ("file", "list", class_files, 1);
1627 c = add_com ("disassemble", class_vars, disassemble_command, _("\
1628 Disassemble a specified section of memory.\n\
1629 Default is the function surrounding the pc of the selected frame.\n\
1630 With a /m modifier, source lines are included (if available).\n\
1631 With a /r modifier, raw instructions in hex are included.\n\
1632 With a single argument, the function surrounding that address is dumped.\n\
1633 Two arguments (separated by a comma) are taken as a range of memory to dump,\n\
1634 in the form of \"start,end\", or \"start,+length\"."));
1635 set_cmd_completer (c, location_completer);
1637 add_com_alias ("va", "disassemble", class_xdb, 0);
1639 /* NOTE: cagney/2000-03-20: Being able to enter ``(gdb) !ls'' would
1640 be a really useful feature. Unfortunately, the below wont do
1641 this. Instead it adds support for the form ``(gdb) ! ls''
1642 (i.e. the space is required). If the ``!'' command below is
1643 added the complains about no ``!'' command would be replaced by
1644 complains about how the ``!'' command is broken :-) */
1646 add_com_alias ("!", "shell", class_support, 0);
1648 c = add_com ("make", class_support, make_command, _("\
1649 Run the ``make'' program using the rest of the line as arguments."));
1650 set_cmd_completer (c, filename_completer);
1651 add_cmd ("user", no_class, show_user, _("\
1652 Show definitions of user defined commands.\n\
1653 Argument is the name of the user defined command.\n\
1654 With no argument, show definitions of all user defined commands."), &showlist);
1655 add_com ("apropos", class_support, apropos_command,
1656 _("Search for commands matching a REGEXP"));
1658 add_setshow_integer_cmd ("max-user-call-depth", no_class,
1659 &max_user_call_depth, _("\
1660 Set the max call depth for user-defined commands."), _("\
1661 Show the max call depth for user-defined commands."), NULL,
1663 show_max_user_call_depth,
1664 &setlist, &showlist);
1666 add_setshow_boolean_cmd ("trace-commands", no_class, &trace_commands, _("\
1667 Set tracing of GDB CLI commands."), _("\
1668 Show state of GDB CLI command tracing."), _("\
1669 When 'on', each command is displayed as it is executed."),
1672 &setlist, &showlist);