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
222 info_command (char *arg, int from_tty)
224 printf_unfiltered (_("\"info\" must be followed by the name of an info command.\n"));
225 help_list (infolist, "info ", -1, gdb_stdout);
228 /* The "show" command with no arguments shows all the settings. */
231 show_command (char *arg, int from_tty)
233 cmd_show_list (showlist, from_tty, "");
236 /* Provide documentation on command or list given by COMMAND. FROM_TTY
240 help_command (char *command, int from_tty)
242 help_cmd (command, gdb_stdout);
245 /* String compare function for qsort. */
247 compare_strings (const void *arg1, const void *arg2)
249 const char **s1 = (const char **) arg1;
250 const char **s2 = (const char **) arg2;
252 return strcmp (*s1, *s2);
255 /* The "complete" command is used by Emacs to implement completion. */
258 complete_command (char *arg, int from_tty)
261 char **completions, *point, *arg_prefix;
267 argpoint = strlen (arg);
269 /* complete_line assumes that its first argument is somewhere
270 within, and except for filenames at the beginning of, the word to
271 be completed. The following crude imitation of readline's
272 word-breaking tries to accomodate this. */
273 point = arg + argpoint;
276 if (strchr (rl_completer_word_break_characters, point[-1]) != 0)
281 arg_prefix = alloca (point - arg + 1);
282 memcpy (arg_prefix, arg, point - arg);
283 arg_prefix[point - arg] = 0;
285 completions = complete_line (point, arg, argpoint);
291 for (size = 0; completions[size]; ++size)
293 qsort (completions, size, sizeof (char *), compare_strings);
295 /* We do extra processing here since we only want to print each
302 printf_unfiltered ("%s%s\n", arg_prefix, completions[item]);
303 next_item = item + 1;
304 while (next_item < size
305 && ! strcmp (completions[item], completions[next_item]))
307 xfree (completions[next_item]);
311 xfree (completions[item]);
320 is_complete_command (struct cmd_list_element *c)
322 return cmd_cfunc_eq (c, complete_command);
326 show_version (char *args, int from_tty)
329 print_gdb_version (gdb_stdout);
330 printf_filtered ("\n");
334 /* Handle the quit command. */
337 quit_command (char *args, int from_tty)
339 if (!quit_confirm ())
340 error (_("Not confirmed."));
342 disconnect_tracing (from_tty);
344 quit_force (args, from_tty);
348 pwd_command (char *args, int from_tty)
351 error (_("The \"pwd\" command does not take an argument: %s"), args);
352 if (! getcwd (gdb_dirbuf, sizeof (gdb_dirbuf)))
353 error (_("Error finding name of working directory: %s"),
354 safe_strerror (errno));
356 if (strcmp (gdb_dirbuf, current_directory) != 0)
357 printf_unfiltered (_("Working directory %s\n (canonically %s).\n"),
358 current_directory, gdb_dirbuf);
360 printf_unfiltered (_("Working directory %s.\n"), current_directory);
364 cd_command (char *dir, int from_tty)
367 /* Found something other than leading repetitions of "/..". */
371 /* If the new directory is absolute, repeat is a no-op; if relative,
372 repeat might be useful but is more likely to be a mistake. */
376 error_no_arg (_("new working directory"));
378 dir = tilde_expand (dir);
379 make_cleanup (xfree, dir);
382 perror_with_name (dir);
384 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
385 /* There's too much mess with DOSish names like "d:", "d:.",
386 "d:./foo" etc. Instead of having lots of special #ifdef'ed code,
387 simply get the canonicalized name of the current directory. */
388 dir = getcwd (gdb_dirbuf, sizeof (gdb_dirbuf));
392 if (IS_DIR_SEPARATOR (dir[len - 1]))
394 /* Remove the trailing slash unless this is a root directory
395 (including a drive letter on non-Unix systems). */
396 if (!(len == 1) /* "/" */
397 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
398 && !(len == 3 && dir[1] == ':') /* "d:/" */
404 dir = savestring (dir, len);
405 if (IS_ABSOLUTE_PATH (dir))
406 current_directory = dir;
409 if (IS_DIR_SEPARATOR (current_directory[strlen (current_directory) - 1]))
410 current_directory = concat (current_directory, dir, (char *)NULL);
412 current_directory = concat (current_directory, SLASH_STRING,
417 /* Now simplify any occurrences of `.' and `..' in the pathname. */
420 for (p = current_directory; *p;)
422 if (IS_DIR_SEPARATOR (p[0]) && p[1] == '.'
423 && (p[2] == 0 || IS_DIR_SEPARATOR (p[2])))
425 else if (IS_DIR_SEPARATOR (p[0]) && p[1] == '.' && p[2] == '.'
426 && (p[3] == 0 || IS_DIR_SEPARATOR (p[3])))
430 /* Search backwards for the directory just before the "/.."
431 and obliterate it and the "/..". */
434 while (q != current_directory && !IS_DIR_SEPARATOR (q[-1]))
437 if (q == current_directory)
438 /* current_directory is
439 a relative pathname ("can't happen"--leave it alone). */
443 strcpy (q - 1, p + 3);
448 /* We are dealing with leading repetitions of "/..", for
449 example "/../..", which is the Mach super-root. */
459 forget_cached_source_info ();
462 pwd_command ((char *) 0, 1);
465 /* Show the current value of the 'script-extension' option. */
468 show_script_ext_mode (struct ui_file *file, int from_tty,
469 struct cmd_list_element *c, const char *value)
471 fprintf_filtered (file, _("\
472 Script filename extension recognition is \"%s\".\n"),
476 /* Try to open SCRIPT_FILE.
477 If successful, the full path name is stored in *FULL_PATHP,
478 the stream is stored in *STREAMP, and return 1.
479 The caller is responsible for freeing *FULL_PATHP.
480 If not successful, return 0; errno is set for the last file
483 If SEARCH_PATH is non-zero, and the file isn't found in cwd,
484 search for it in the source search path.
486 NOTE: This calls openp which uses xfullpath to compute the full path
487 instead of gdb_realpath. Symbolic links are not resolved. */
490 find_and_open_script (const char *script_file, int search_path,
491 FILE **streamp, char **full_pathp)
495 struct cleanup *old_cleanups;
496 int search_flags = OPF_TRY_CWD_FIRST;
498 file = tilde_expand (script_file);
499 old_cleanups = make_cleanup (xfree, file);
502 search_flags |= OPF_SEARCH_IN_PATH;
504 /* Search for and open 'file' on the search path used for source
505 files. Put the full location in *FULL_PATHP. */
506 fd = openp (source_path, search_flags,
507 file, O_RDONLY, full_pathp);
511 int save_errno = errno;
512 do_cleanups (old_cleanups);
517 do_cleanups (old_cleanups);
519 *streamp = fdopen (fd, FOPEN_RT);
523 /* Load script FILE, which has already been opened as STREAM.
524 STREAM is closed before we return. */
527 source_script_from_stream (FILE *stream, const char *file)
529 if (script_ext_mode != script_ext_off
530 && strlen (file) > 3 && !strcmp (&file[strlen (file) - 3], ".py"))
532 volatile struct gdb_exception e;
534 TRY_CATCH (e, RETURN_MASK_ERROR)
536 source_python_script (stream, file);
540 /* Should we fallback to ye olde GDB script mode? */
541 if (script_ext_mode == script_ext_soft
542 && e.reason == RETURN_ERROR && e.error == UNSUPPORTED_ERROR)
544 fseek (stream, 0, SEEK_SET);
545 script_from_file (stream, (char*) file);
549 /* Nope, just punt. */
558 script_from_file (stream, file);
561 /* Worker to perform the "source" command.
563 If SEARCH_PATH is non-zero, and the file isn't found in cwd,
564 search for it in the source search path. */
567 source_script_with_search (const char *file, int from_tty, int search_path)
571 struct cleanup *old_cleanups;
573 if (file == NULL || *file == 0)
574 error (_("source command requires file name of file to source."));
576 if (!find_and_open_script (file, search_path, &stream, &full_path))
578 /* The script wasn't found, or was otherwise inaccessible.
579 If the source command was invoked interactively, throw an
580 error. Otherwise (e.g. if it was invoked by a script),
581 silently ignore the error. */
583 perror_with_name (file);
588 old_cleanups = make_cleanup (xfree, full_path);
589 source_script_from_stream (stream, file);
590 do_cleanups (old_cleanups);
593 /* Wrapper around source_script_with_search to export it to main.c
594 for use in loading .gdbinit scripts. */
597 source_script (char *file, int from_tty)
599 source_script_with_search (file, from_tty, 0);
602 /* Return the source_verbose global variable to its previous state
603 on exit from the source command, by whatever means. */
605 source_verbose_cleanup (void *old_value)
607 source_verbose = *(int *)old_value;
612 source_command (char *args, int from_tty)
614 struct cleanup *old_cleanups;
616 int *old_source_verbose = xmalloc (sizeof(int));
619 *old_source_verbose = source_verbose;
620 old_cleanups = make_cleanup (source_verbose_cleanup,
623 /* -v causes the source command to run in verbose mode.
624 -s causes the file to be searched in the source search path,
625 even if the file name contains a '/'.
626 We still have to be able to handle filenames with spaces in a
627 backward compatible way, so buildargv is not appropriate. */
631 while (args[0] != '\0')
633 /* Make sure leading white space does not break the
635 while (isspace(args[0]))
641 if (args[1] == 'v' && isspace (args[2]))
645 /* Skip passed -v. */
648 else if (args[1] == 's' && isspace (args[2]))
652 /* Skip passed -s. */
659 while (isspace (args[0]))
664 source_script_with_search (file, from_tty, search_path);
666 do_cleanups (old_cleanups);
671 echo_command (char *text, int from_tty)
677 while ((c = *p++) != '\0')
681 /* \ at end of argument is used after spaces
682 so they won't be lost. */
686 c = parse_escape (get_current_arch (), &p);
688 printf_filtered ("%c", c);
691 printf_filtered ("%c", c);
694 /* Force this output to appear now. */
696 gdb_flush (gdb_stdout);
700 shell_escape (char *arg, int from_tty)
702 #if defined(CANT_FORK) || \
703 (!defined(HAVE_WORKING_VFORK) && !defined(HAVE_WORKING_FORK))
704 /* If ARG is NULL, they want an inferior shell, but `system' just
705 reports if the shell is available when passed a NULL arg. */
706 int rc = system (arg ? arg : "");
709 arg = "inferior shell";
713 fprintf_unfiltered (gdb_stderr, "Cannot execute %s: %s\n", arg,
714 safe_strerror (errno));
715 gdb_flush (gdb_stderr);
719 fprintf_unfiltered (gdb_stderr, "%s exited with status %d\n", arg, rc);
720 gdb_flush (gdb_stderr);
723 /* Make sure to return to the directory GDB thinks it is, in case
724 the shell command we just ran changed it. */
725 chdir (current_directory);
727 #else /* Can fork. */
730 if ((pid = vfork ()) == 0)
732 char *p, *user_shell;
734 if ((user_shell = (char *) getenv ("SHELL")) == NULL)
735 user_shell = "/bin/sh";
737 /* Get the name of the shell for arg0. */
738 if ((p = strrchr (user_shell, '/')) == NULL)
741 p++; /* Get past '/' */
744 execl (user_shell, p, (char *) 0);
746 execl (user_shell, p, "-c", arg, (char *) 0);
748 fprintf_unfiltered (gdb_stderr, "Cannot execute %s: %s\n", user_shell,
749 safe_strerror (errno));
750 gdb_flush (gdb_stderr);
755 while ((rc = wait (&status)) != pid && rc != -1)
758 error (_("Fork failed"));
759 #endif /* Can fork. */
763 edit_command (char *arg, int from_tty)
765 struct symtabs_and_lines sals;
766 struct symtab_and_line sal;
772 /* Pull in the current default source line if necessary. */
775 set_default_source_symtab_and_line ();
776 sal = get_current_source_symtab_and_line ();
779 /* Bare "edit" edits file with present line. */
784 error (_("No default source file yet."));
785 sal.line += get_lines_to_list () / 2;
789 /* Now should only be one argument -- decode it in SAL. */
792 sals = decode_line_1 (&arg1, 0, 0, 0, 0, 0);
801 ambiguous_line_spec (&sals);
810 error (_("Junk at end of line specification."));
812 /* If line was specified by address, first print exactly which
813 line, and which file. In this case, sal.symtab == 0 means
814 address is outside of all known source files, not that user
815 failed to give a filename. */
818 struct gdbarch *gdbarch;
821 /* FIXME-32x64--assumes sal.pc fits in long. */
822 error (_("No source file for address %s."),
823 hex_string ((unsigned long) sal.pc));
825 gdbarch = get_objfile_arch (sal.symtab->objfile);
826 sym = find_pc_function (sal.pc);
828 printf_filtered ("%s is in %s (%s:%d).\n",
829 paddress (gdbarch, sal.pc),
830 SYMBOL_PRINT_NAME (sym),
831 sal.symtab->filename, sal.line);
833 printf_filtered ("%s is at %s:%d.\n",
834 paddress (gdbarch, sal.pc),
835 sal.symtab->filename, sal.line);
838 /* If what was given does not imply a symtab, it must be an
839 undebuggable symbol which means no source code. */
842 error (_("No line number known for %s."), arg);
845 if ((editor = (char *) getenv ("EDITOR")) == NULL)
848 /* If we don't already know the full absolute file name of the
849 source file, find it now. */
850 if (!sal.symtab->fullname)
852 fn = symtab_to_fullname (sal.symtab);
857 fn = sal.symtab->fullname;
859 /* Quote the file name, in case it has whitespace or other special
861 p = xstrprintf ("%s +%d \"%s\"", editor, sal.line, fn);
862 shell_escape (p, from_tty);
867 list_command (char *arg, int from_tty)
869 struct symtabs_and_lines sals, sals_end;
870 struct symtab_and_line sal = { 0 };
871 struct symtab_and_line sal_end = { 0 };
872 struct symtab_and_line cursal = { 0 };
881 /* Pull in the current default source line if necessary. */
882 if (arg == 0 || arg[0] == '+' || arg[0] == '-')
884 set_default_source_symtab_and_line ();
885 cursal = get_current_source_symtab_and_line ();
888 /* "l" or "l +" lists next ten lines. */
890 if (arg == 0 || strcmp (arg, "+") == 0)
892 print_source_lines (cursal.symtab, cursal.line,
893 cursal.line + get_lines_to_list (), 0);
897 /* "l -" lists previous ten lines, the ones before the ten just
899 if (strcmp (arg, "-") == 0)
901 print_source_lines (cursal.symtab,
902 max (get_first_line_listed () - get_lines_to_list (), 1),
903 get_first_line_listed (), 0);
907 /* Now if there is only one argument, decode it in SAL
909 If there are two arguments, decode them in SAL and SAL_END
910 and clear NO_END; however, if one of the arguments is blank,
911 set DUMMY_BEG or DUMMY_END to record that fact. */
913 if (!have_full_symbols () && !have_partial_symbols ())
914 error (_("No symbol table is loaded. Use the \"file\" command."));
921 sals = decode_line_1 (&arg1, 0, 0, 0, 0, 0);
927 ambiguous_line_spec (&sals);
936 /* Record whether the BEG arg is all digits. */
938 for (p = arg; p != arg1 && *p >= '0' && *p <= '9'; p++);
939 linenum_beg = (p == arg1);
941 while (*arg1 == ' ' || *arg1 == '\t')
947 while (*arg1 == ' ' || *arg1 == '\t')
954 sals_end = decode_line_1 (&arg1, 0, 0, 0, 0, 0);
956 sals_end = decode_line_1 (&arg1, 0, sal.symtab, sal.line, 0, 0);
957 if (sals_end.nelts == 0)
959 if (sals_end.nelts > 1)
961 ambiguous_line_spec (&sals_end);
962 xfree (sals_end.sals);
965 sal_end = sals_end.sals[0];
966 xfree (sals_end.sals);
971 error (_("Junk at end of line specification."));
973 if (!no_end && !dummy_beg && !dummy_end
974 && sal.symtab != sal_end.symtab)
975 error (_("Specified start and end are in different files."));
976 if (dummy_beg && dummy_end)
977 error (_("Two empty args do not say what lines to list."));
979 /* If line was specified by address,
980 first print exactly which line, and which file.
982 In this case, sal.symtab == 0 means address is outside of all
983 known source files, not that user failed to give a filename. */
986 struct gdbarch *gdbarch;
989 /* FIXME-32x64--assumes sal.pc fits in long. */
990 error (_("No source file for address %s."),
991 hex_string ((unsigned long) sal.pc));
993 gdbarch = get_objfile_arch (sal.symtab->objfile);
994 sym = find_pc_function (sal.pc);
996 printf_filtered ("%s is in %s (%s:%d).\n",
997 paddress (gdbarch, sal.pc),
998 SYMBOL_PRINT_NAME (sym),
999 sal.symtab->filename, sal.line);
1001 printf_filtered ("%s is at %s:%d.\n",
1002 paddress (gdbarch, sal.pc),
1003 sal.symtab->filename, sal.line);
1006 /* If line was not specified by just a line number, and it does not
1007 imply a symtab, it must be an undebuggable symbol which means no
1010 if (!linenum_beg && sal.symtab == 0)
1011 error (_("No line number known for %s."), arg);
1013 /* If this command is repeated with RET,
1014 turn it into the no-arg variant. */
1019 if (dummy_beg && sal_end.symtab == 0)
1020 error (_("No default source file yet. Do \"help list\"."));
1022 print_source_lines (sal_end.symtab,
1023 max (sal_end.line - (get_lines_to_list () - 1), 1),
1024 sal_end.line + 1, 0);
1025 else if (sal.symtab == 0)
1026 error (_("No default source file yet. Do \"help list\"."));
1029 int first_line = sal.line - get_lines_to_list () / 2;
1031 if (first_line < 1) first_line = 1;
1033 print_source_lines (sal.symtab,
1035 first_line + get_lines_to_list (),
1039 print_source_lines (sal.symtab, sal.line,
1041 ? sal.line + get_lines_to_list ()
1042 : sal_end.line + 1),
1046 /* Subroutine of disassemble_command to simplify it.
1047 Perform the disassembly.
1048 NAME is the name of the function if known, or NULL.
1049 [LOW,HIGH) are the range of addresses to disassemble.
1050 MIXED is non-zero to print source with the assembler. */
1053 print_disassembly (struct gdbarch *gdbarch, const char *name,
1054 CORE_ADDR low, CORE_ADDR high, int flags)
1057 if (!tui_is_window_visible (DISASSEM_WIN))
1060 printf_filtered ("Dump of assembler code ");
1062 printf_filtered ("for function %s:\n", name);
1064 printf_filtered ("from %s to %s:\n",
1065 paddress (gdbarch, low), paddress (gdbarch, high));
1067 /* Dump the specified range. */
1068 gdb_disassembly (gdbarch, uiout, 0, flags, -1, low, high);
1070 printf_filtered ("End of assembler dump.\n");
1071 gdb_flush (gdb_stdout);
1076 tui_show_assembly (gdbarch, low);
1081 /* Subroutine of disassemble_command to simplify it.
1082 Print a disassembly of the current function according to FLAGS. */
1085 disassemble_current_function (int flags)
1087 struct frame_info *frame;
1088 struct gdbarch *gdbarch;
1089 CORE_ADDR low, high, pc;
1092 frame = get_selected_frame (_("No frame selected."));
1093 gdbarch = get_frame_arch (frame);
1094 pc = get_frame_pc (frame);
1095 if (find_pc_partial_function (pc, &name, &low, &high) == 0)
1096 error (_("No function contains program counter for selected frame."));
1098 /* NOTE: cagney/2003-02-13 The `tui_active' was previously
1101 /* FIXME: cagney/2004-02-07: This should be an observer. */
1102 low = tui_get_low_disassembly_address (gdbarch, low, pc);
1104 low += gdbarch_deprecated_function_start_offset (gdbarch);
1106 print_disassembly (gdbarch, name, low, high, flags);
1109 /* Dump a specified section of assembly code.
1113 - dump the assembly code for the function of the current pc
1114 disassemble [/mr] addr
1115 - dump the assembly code for the function at ADDR
1116 disassemble [/mr] low,high
1117 disassemble [/mr] low,+length
1118 - dump the assembly code in the range [LOW,HIGH), or [LOW,LOW+length)
1120 A /m modifier will include source code with the assembly.
1121 A /r modifier will include raw instructions in hex with the assembly. */
1124 disassemble_command (char *arg, int from_tty)
1126 struct gdbarch *gdbarch = get_current_arch ();
1127 CORE_ADDR low, high;
1135 if (arg && *arg == '/')
1140 error (_("Missing modifier."));
1142 while (*arg && ! isspace (*arg))
1147 flags |= DISASSEMBLY_SOURCE;
1150 flags |= DISASSEMBLY_RAW_INSN;
1153 error (_("Invalid disassembly modifier."));
1157 while (isspace (*arg))
1161 if (! arg || ! *arg)
1163 flags |= DISASSEMBLY_OMIT_FNAME;
1164 disassemble_current_function (flags);
1168 pc = value_as_address (parse_to_comma_and_eval (&arg));
1174 if (find_pc_partial_function (pc, &name, &low, &high) == 0)
1175 error (_("No function contains specified address."));
1177 /* NOTE: cagney/2003-02-13 The `tui_active' was previously
1180 /* FIXME: cagney/2004-02-07: This should be an observer. */
1181 low = tui_get_low_disassembly_address (gdbarch, low, pc);
1183 low += gdbarch_deprecated_function_start_offset (gdbarch);
1184 flags |= DISASSEMBLY_OMIT_FNAME;
1188 /* Two arguments. */
1191 while (isspace (*arg))
1198 high = parse_and_eval_address (arg);
1203 print_disassembly (gdbarch, name, low, high, flags);
1207 make_command (char *arg, int from_tty)
1215 p = xmalloc (sizeof ("make ") + strlen (arg));
1216 strcpy (p, "make ");
1217 strcpy (p + sizeof ("make ") - 1, arg);
1220 shell_escape (p, from_tty);
1224 show_user (char *args, int from_tty)
1226 struct cmd_list_element *c;
1227 extern struct cmd_list_element *cmdlist;
1231 char *comname = args;
1233 c = lookup_cmd (&comname, cmdlist, "", 0, 1);
1234 if (c->class != class_user)
1235 error (_("Not a user command."));
1236 show_user_1 (c, "", args, gdb_stdout);
1240 for (c = cmdlist; c; c = c->next)
1242 if (c->class == class_user || c->prefixlist != NULL)
1243 show_user_1 (c, "", c->name, gdb_stdout);
1248 /* Search through names of commands and documentations for a certain
1249 regular expression. */
1252 apropos_command (char *searchstr, int from_tty)
1254 extern struct cmd_list_element *cmdlist; /* This is the main command
1257 char *pattern_fastmap;
1258 char errorbuffer[512];
1260 pattern_fastmap = xcalloc (256, sizeof (char));
1261 if (searchstr == NULL)
1262 error (_("REGEXP string is empty"));
1264 if (regcomp(&pattern,searchstr,REG_ICASE) == 0)
1266 pattern.fastmap=pattern_fastmap;
1267 re_compile_fastmap(&pattern);
1268 apropos_cmd (gdb_stdout,cmdlist,&pattern,"");
1272 regerror(regcomp(&pattern,searchstr,REG_ICASE),NULL,errorbuffer,512);
1273 error (_("Error in regular expression:%s"),errorbuffer);
1275 xfree (pattern_fastmap);
1278 /* Print a list of files and line numbers which a user may choose from
1279 in order to list a function which was specified ambiguously (as
1280 with `list classname::overloadedfuncname', for example). The
1281 vector in SALS provides the filenames and line numbers. */
1284 ambiguous_line_spec (struct symtabs_and_lines *sals)
1288 for (i = 0; i < sals->nelts; ++i)
1289 printf_filtered (_("file: \"%s\", line number: %d\n"),
1290 sals->sals[i].symtab->filename, sals->sals[i].line);
1294 set_debug (char *arg, int from_tty)
1296 printf_unfiltered (_("\"set debug\" must be followed by the name of a debug subcommand.\n"));
1297 help_list (setdebuglist, "set debug ", -1, gdb_stdout);
1301 show_debug (char *args, int from_tty)
1303 cmd_show_list (showdebuglist, from_tty, "");
1307 init_cmd_lists (void)
1309 max_user_call_depth = 1024;
1319 enablebreaklist = NULL;
1324 showhistlist = NULL;
1325 unsethistlist = NULL;
1326 maintenancelist = NULL;
1327 maintenanceinfolist = NULL;
1328 maintenanceprintlist = NULL;
1329 setprintlist = NULL;
1330 showprintlist = NULL;
1331 setchecklist = NULL;
1332 showchecklist = NULL;
1336 show_info_verbose (struct ui_file *file, int from_tty,
1337 struct cmd_list_element *c,
1341 fprintf_filtered (file, _("\
1342 Verbose printing of informational messages is %s.\n"), value);
1344 fprintf_filtered (file, _("Verbosity is %s.\n"), value);
1348 show_history_expansion_p (struct ui_file *file, int from_tty,
1349 struct cmd_list_element *c, const char *value)
1351 fprintf_filtered (file, _("History expansion on command input is %s.\n"),
1356 show_baud_rate (struct ui_file *file, int from_tty,
1357 struct cmd_list_element *c, const char *value)
1359 fprintf_filtered (file, _("Baud rate for remote serial I/O is %s.\n"),
1364 show_remote_debug (struct ui_file *file, int from_tty,
1365 struct cmd_list_element *c, const char *value)
1367 fprintf_filtered (file, _("Debugging of remote protocol is %s.\n"),
1372 show_remote_timeout (struct ui_file *file, int from_tty,
1373 struct cmd_list_element *c, const char *value)
1375 fprintf_filtered (file, _("\
1376 Timeout limit to wait for target to respond is %s.\n"),
1381 show_max_user_call_depth (struct ui_file *file, int from_tty,
1382 struct cmd_list_element *c, const char *value)
1384 fprintf_filtered (file, _("\
1385 The max call depth for user-defined commands is %s.\n"),
1391 init_cli_cmds (void)
1393 struct cmd_list_element *c;
1394 char *source_help_text;
1396 /* Define the classes of commands.
1397 They will appear in the help list in the reverse of this order. */
1399 add_cmd ("internals", class_maintenance, NULL, _("\
1400 Maintenance commands.\n\
1401 Some gdb commands are provided just for use by gdb maintainers.\n\
1402 These commands are subject to frequent change, and may not be as\n\
1403 well documented as user commands."),
1405 add_cmd ("obscure", class_obscure, NULL, _("Obscure features."), &cmdlist);
1406 add_cmd ("aliases", class_alias, NULL, _("Aliases of other commands."), &cmdlist);
1407 add_cmd ("user-defined", class_user, NULL, _("\
1408 User-defined commands.\n\
1409 The commands in this class are those defined by the user.\n\
1410 Use the \"define\" command to define a command."), &cmdlist);
1411 add_cmd ("support", class_support, NULL, _("Support facilities."), &cmdlist);
1413 add_cmd ("status", class_info, NULL, _("Status inquiries."), &cmdlist);
1414 add_cmd ("files", class_files, NULL, _("Specifying and examining files."),
1416 add_cmd ("breakpoints", class_breakpoint, NULL,
1417 _("Making program stop at certain points."), &cmdlist);
1418 add_cmd ("data", class_vars, NULL, _("Examining data."), &cmdlist);
1419 add_cmd ("stack", class_stack, NULL, _("\
1420 Examining the stack.\n\
1421 The stack is made up of stack frames. Gdb assigns numbers to stack frames\n\
1422 counting from zero for the innermost (currently executing) frame.\n\n\
1423 At any time gdb identifies one frame as the \"selected\" frame.\n\
1424 Variable lookups are done with respect to the selected frame.\n\
1425 When the program being debugged stops, gdb selects the innermost frame.\n\
1426 The commands below can be used to select other frames by number or address."),
1428 add_cmd ("running", class_run, NULL, _("Running the program."), &cmdlist);
1430 /* Define general commands. */
1432 add_com ("pwd", class_files, pwd_command, _("\
1433 Print working directory. This is used for your program as well."));
1435 c = add_cmd ("cd", class_files, cd_command, _("\
1436 Set working directory to DIR for debugger and program being debugged.\n\
1437 The change does not take effect for the program being debugged\n\
1438 until the next time it is started."), &cmdlist);
1439 set_cmd_completer (c, filename_completer);
1441 add_com ("echo", class_support, echo_command, _("\
1442 Print a constant string. Give string as argument.\n\
1443 C escape sequences may be used in the argument.\n\
1444 No newline is added at the end of the argument;\n\
1445 use \"\\n\" if you want a newline to be printed.\n\
1446 Since leading and trailing whitespace are ignored in command arguments,\n\
1447 if you want to print some you must use \"\\\" before leading whitespace\n\
1448 to be printed or after trailing whitespace."));
1449 add_com ("document", class_support, document_command, _("\
1450 Document a user-defined command.\n\
1451 Give command name as argument. Give documentation on following lines.\n\
1452 End with a line of just \"end\"."));
1453 add_com ("define", class_support, define_command, _("\
1454 Define a new command name. Command name is argument.\n\
1455 Definition appears on following lines, one command per line.\n\
1456 End with a line of just \"end\".\n\
1457 Use the \"document\" command to give documentation for the new command.\n\
1458 Commands defined in this way may have up to ten arguments."));
1460 source_help_text = xstrprintf (_("\
1461 Read commands from a file named FILE.\n\
1463 Usage: source [-s] [-v] FILE\n\
1464 -s: search for the script in the source search path,\n\
1465 even if FILE contains directories.\n\
1466 -v: each command in FILE is echoed as it is executed.\n\
1468 Note that the file \"%s\" is read automatically in this way\n\
1469 when GDB is started."), gdbinit);
1470 c = add_cmd ("source", class_support, source_command,
1471 source_help_text, &cmdlist);
1472 set_cmd_completer (c, filename_completer);
1474 add_setshow_enum_cmd ("script-extension", class_support,
1475 script_ext_enums, &script_ext_mode, _("\
1476 Set mode for script filename extension recognition."), _("\
1477 Show mode for script filename extension recognition."), _("\
1478 off == no filename extension recognition (all sourced files are GDB scripts)\n\
1479 soft == evaluate script according to filename extension, fallback to GDB script"
1481 strict == evaluate script according to filename extension, error if not supported"
1484 show_script_ext_mode,
1485 &setlist, &showlist);
1487 add_com ("quit", class_support, quit_command, _("Exit gdb."));
1488 c = add_com ("help", class_support, help_command,
1489 _("Print list of commands."));
1490 set_cmd_completer (c, command_completer);
1491 add_com_alias ("q", "quit", class_support, 1);
1492 add_com_alias ("h", "help", class_support, 1);
1494 add_setshow_boolean_cmd ("verbose", class_support, &info_verbose, _("\
1495 Set verbosity."), _("\
1496 Show verbosity."), NULL,
1499 &setlist, &showlist);
1501 add_prefix_cmd ("history", class_support, set_history,
1502 _("Generic command for setting command history parameters."),
1503 &sethistlist, "set history ", 0, &setlist);
1504 add_prefix_cmd ("history", class_support, show_history,
1505 _("Generic command for showing command history parameters."),
1506 &showhistlist, "show history ", 0, &showlist);
1508 add_setshow_boolean_cmd ("expansion", no_class, &history_expansion_p, _("\
1509 Set history expansion on command input."), _("\
1510 Show history expansion on command input."), _("\
1511 Without an argument, history expansion is enabled."),
1513 show_history_expansion_p,
1514 &sethistlist, &showhistlist);
1516 add_prefix_cmd ("info", class_info, info_command, _("\
1517 Generic command for showing things about the program being debugged."),
1518 &infolist, "info ", 0, &cmdlist);
1519 add_com_alias ("i", "info", class_info, 1);
1520 add_com_alias ("inf", "info", class_info, 1);
1522 add_com ("complete", class_obscure, complete_command,
1523 _("List the completions for the rest of the line as a command."));
1525 add_prefix_cmd ("show", class_info, show_command, _("\
1526 Generic command for showing things about the debugger."),
1527 &showlist, "show ", 0, &cmdlist);
1528 /* Another way to get at the same thing. */
1529 add_info ("set", show_command, _("Show all GDB settings."));
1531 add_cmd ("commands", no_class, show_commands, _("\
1532 Show the history of commands you typed.\n\
1533 You can supply a command number to start with, or a `+' to start after\n\
1534 the previous command number shown."),
1537 add_cmd ("version", no_class, show_version,
1538 _("Show what version of GDB this is."), &showlist);
1540 add_com ("while", class_support, while_command, _("\
1541 Execute nested commands WHILE the conditional expression is non zero.\n\
1542 The conditional expression must follow the word `while' and must in turn be\n\
1543 followed by a new line. The nested commands must be entered one per line,\n\
1544 and should be terminated by the word `end'."));
1546 add_com ("if", class_support, if_command, _("\
1547 Execute nested commands once IF the conditional expression is non zero.\n\
1548 The conditional expression must follow the word `if' and must in turn be\n\
1549 followed by a new line. The nested commands must be entered one per line,\n\
1550 and should be terminated by the word 'else' or `end'. If an else clause\n\
1551 is used, the same rules apply to its nested commands as to the first ones."));
1553 /* If target is open when baud changes, it doesn't take effect until
1554 the next open (I think, not sure). */
1555 add_setshow_zinteger_cmd ("remotebaud", no_class, &baud_rate, _("\
1556 Set baud rate for remote serial I/O."), _("\
1557 Show baud rate for remote serial I/O."), _("\
1558 This value is used to set the speed of the serial port when debugging\n\
1559 using remote targets."),
1562 &setlist, &showlist);
1564 add_setshow_zinteger_cmd ("remote", no_class, &remote_debug, _("\
1565 Set debugging of remote protocol."), _("\
1566 Show debugging of remote protocol."), _("\
1567 When enabled, each packet sent or received with the remote target\n\
1571 &setdebuglist, &showdebuglist);
1573 add_setshow_integer_cmd ("remotetimeout", no_class, &remote_timeout, _("\
1574 Set timeout limit to wait for target to respond."), _("\
1575 Show timeout limit to wait for target to respond."), _("\
1576 This value is used to set the time limit for gdb to wait for a response\n\
1579 show_remote_timeout,
1580 &setlist, &showlist);
1582 add_prefix_cmd ("debug", no_class, set_debug,
1583 _("Generic command for setting gdb debugging flags"),
1584 &setdebuglist, "set debug ", 0, &setlist);
1586 add_prefix_cmd ("debug", no_class, show_debug,
1587 _("Generic command for showing gdb debugging flags"),
1588 &showdebuglist, "show debug ", 0, &showlist);
1590 c = add_com ("shell", class_support, shell_escape, _("\
1591 Execute the rest of the line as a shell command.\n\
1592 With no arguments, run an inferior shell."));
1593 set_cmd_completer (c, filename_completer);
1595 c = add_com ("edit", class_files, edit_command, _("\
1596 Edit specified file or function.\n\
1597 With no argument, edits file containing most recent line listed.\n\
1598 Editing targets can be specified in these ways:\n\
1599 FILE:LINENUM, to edit at that line in that file,\n\
1600 FUNCTION, to edit at the beginning of that function,\n\
1601 FILE:FUNCTION, to distinguish among like-named static functions.\n\
1602 *ADDRESS, to edit at the line containing that address.\n\
1603 Uses EDITOR environment variable contents as editor (or ex as default)."));
1605 c->completer = location_completer;
1607 add_com ("list", class_files, list_command, _("\
1608 List specified function or line.\n\
1609 With no argument, lists ten more lines after or around previous listing.\n\
1610 \"list -\" lists the ten lines before a previous ten-line listing.\n\
1611 One argument specifies a line, and ten lines are listed around that line.\n\
1612 Two arguments with comma between specify starting and ending lines to list.\n\
1613 Lines can be specified in these ways:\n\
1614 LINENUM, to list around that line in current file,\n\
1615 FILE:LINENUM, to list around that line in that file,\n\
1616 FUNCTION, to list around beginning of that function,\n\
1617 FILE:FUNCTION, to distinguish among like-named static functions.\n\
1618 *ADDRESS, to list around the line containing that address.\n\
1619 With two args if one is empty it stands for ten lines away from the other arg."));
1622 add_com_alias ("l", "list", class_files, 1);
1624 add_com_alias ("v", "list", class_files, 1);
1627 add_com_alias ("file", "list", class_files, 1);
1629 c = add_com ("disassemble", class_vars, disassemble_command, _("\
1630 Disassemble a specified section of memory.\n\
1631 Default is the function surrounding the pc of the selected frame.\n\
1632 With a /m modifier, source lines are included (if available).\n\
1633 With a /r modifier, raw instructions in hex are included.\n\
1634 With a single argument, the function surrounding that address is dumped.\n\
1635 Two arguments (separated by a comma) are taken as a range of memory to dump,\n\
1636 in the form of \"start,end\", or \"start,+length\"."));
1637 set_cmd_completer (c, location_completer);
1639 add_com_alias ("va", "disassemble", class_xdb, 0);
1641 /* NOTE: cagney/2000-03-20: Being able to enter ``(gdb) !ls'' would
1642 be a really useful feature. Unfortunately, the below wont do
1643 this. Instead it adds support for the form ``(gdb) ! ls''
1644 (i.e. the space is required). If the ``!'' command below is
1645 added the complains about no ``!'' command would be replaced by
1646 complains about how the ``!'' command is broken :-) */
1648 add_com_alias ("!", "shell", class_support, 0);
1650 c = add_com ("make", class_support, make_command, _("\
1651 Run the ``make'' program using the rest of the line as arguments."));
1652 set_cmd_completer (c, filename_completer);
1653 add_cmd ("user", no_class, show_user, _("\
1654 Show definitions of user defined commands.\n\
1655 Argument is the name of the user defined command.\n\
1656 With no argument, show definitions of all user defined commands."), &showlist);
1657 add_com ("apropos", class_support, apropos_command,
1658 _("Search for commands matching a REGEXP"));
1660 add_setshow_integer_cmd ("max-user-call-depth", no_class,
1661 &max_user_call_depth, _("\
1662 Set the max call depth for user-defined commands."), _("\
1663 Show the max call depth for user-defined commands."), NULL,
1665 show_max_user_call_depth,
1666 &setlist, &showlist);
1668 add_setshow_boolean_cmd ("trace-commands", no_class, &trace_commands, _("\
1669 Set tracing of GDB CLI commands."), _("\
1670 Show state of GDB CLI command tracing."), _("\
1671 When 'on', each command is displayed as it is executed."),
1674 &setlist, &showlist);