3 Copyright (C) 2000-2020 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
21 #include "arch-utils.h"
22 #include "readline/tilde.h"
23 #include "completer.h"
24 #include "target.h" /* For baud_rate, remote_debug and remote_timeout. */
25 #include "gdbsupport/gdb_wait.h" /* For shell escape implementation. */
27 #include "gdb_regex.h" /* Used by apropos_command. */
28 #include "gdb_vfork.h"
30 #include "expression.h"
34 #include "filenames.h" /* For DOSish file names. */
38 #include "tracepoint.h"
39 #include "gdbsupport/filestuff.h"
47 #include "cli/cli-decode.h"
48 #include "cli/cli-script.h"
49 #include "cli/cli-setshow.h"
50 #include "cli/cli-cmds.h"
51 #include "cli/cli-style.h"
52 #include "cli/cli-utils.h"
54 #include "extension.h"
55 #include "gdbsupport/pathstuff.h"
58 #include "tui/tui.h" /* For tui_active et.al. */
65 /* Prototypes for local utility functions */
67 static void print_sal_location (const symtab_and_line
&sal
);
69 static void ambiguous_line_spec (gdb::array_view
<const symtab_and_line
> sals
,
70 const char *format
, ...)
71 ATTRIBUTE_PRINTF (2, 3);
73 static void filter_sals (std::vector
<symtab_and_line
> &);
77 unsigned int max_user_call_depth
;
79 /* Define all cmd_list_elements. */
81 /* Chain containing all defined commands. */
83 struct cmd_list_element
*cmdlist
;
85 /* Chain containing all defined info subcommands. */
87 struct cmd_list_element
*infolist
;
89 /* Chain containing all defined enable subcommands. */
91 struct cmd_list_element
*enablelist
;
93 /* Chain containing all defined disable subcommands. */
95 struct cmd_list_element
*disablelist
;
97 /* Chain containing all defined stop subcommands. */
99 struct cmd_list_element
*stoplist
;
101 /* Chain containing all defined delete subcommands. */
103 struct cmd_list_element
*deletelist
;
105 /* Chain containing all defined detach subcommands. */
107 struct cmd_list_element
*detachlist
;
109 /* Chain containing all defined kill subcommands. */
111 struct cmd_list_element
*killlist
;
113 /* Chain containing all defined set subcommands */
115 struct cmd_list_element
*setlist
;
117 /* Chain containing all defined unset subcommands */
119 struct cmd_list_element
*unsetlist
;
121 /* Chain containing all defined show subcommands. */
123 struct cmd_list_element
*showlist
;
125 /* Chain containing all defined \"set history\". */
127 struct cmd_list_element
*sethistlist
;
129 /* Chain containing all defined \"show history\". */
131 struct cmd_list_element
*showhistlist
;
133 /* Chain containing all defined \"unset history\". */
135 struct cmd_list_element
*unsethistlist
;
137 /* Chain containing all defined maintenance subcommands. */
139 struct cmd_list_element
*maintenancelist
;
141 /* Chain containing all defined "maintenance info" subcommands. */
143 struct cmd_list_element
*maintenanceinfolist
;
145 /* Chain containing all defined "maintenance print" subcommands. */
147 struct cmd_list_element
*maintenanceprintlist
;
149 /* Chain containing all defined "maintenance check" subcommands. */
151 struct cmd_list_element
*maintenancechecklist
;
153 struct cmd_list_element
*setprintlist
;
155 struct cmd_list_element
*showprintlist
;
157 struct cmd_list_element
*setdebuglist
;
159 struct cmd_list_element
*showdebuglist
;
161 struct cmd_list_element
*setchecklist
;
163 struct cmd_list_element
*showchecklist
;
165 /* Command tracing state. */
167 int source_verbose
= 0;
168 bool trace_commands
= false;
170 /* 'script-extension' option support. */
172 static const char script_ext_off
[] = "off";
173 static const char script_ext_soft
[] = "soft";
174 static const char script_ext_strict
[] = "strict";
176 static const char *const script_ext_enums
[] = {
183 static const char *script_ext_mode
= script_ext_soft
;
185 /* Utility used everywhere when at least one argument is needed and
189 error_no_arg (const char *why
)
191 error (_("Argument required (%s)."), why
);
194 /* The "info" command is defined as a prefix, with allow_unknown = 0.
195 Therefore, its own definition is called only for "info" with no
199 info_command (const char *arg
, int from_tty
)
201 printf_unfiltered (_("\"info\" must be followed by "
202 "the name of an info command.\n"));
203 help_list (infolist
, "info ", all_commands
, gdb_stdout
);
206 /* The "show" command with no arguments shows all the settings. */
209 show_command (const char *arg
, int from_tty
)
211 cmd_show_list (showlist
, from_tty
, "");
214 /* See cli/cli-cmds.h. */
217 with_command_1 (const char *set_cmd_prefix
,
218 cmd_list_element
*setlist
, const char *args
, int from_tty
)
221 error (_("Missing arguments."));
223 const char *delim
= strstr (args
, "--");
224 const char *nested_cmd
= nullptr;
227 error (_("Missing setting before '--' delimiter"));
229 if (delim
== nullptr || *skip_spaces (&delim
[2]) == '\0')
230 nested_cmd
= repeat_previous ();
232 cmd_list_element
*set_cmd
= lookup_cmd (&args
, setlist
, set_cmd_prefix
,
233 /*allow_unknown=*/ 0,
234 /*ignore_help_classes=*/ 1);
235 gdb_assert (set_cmd
!= nullptr);
237 if (set_cmd
->var
== nullptr)
238 error (_("Cannot use this setting with the \"with\" command"));
240 std::string temp_value
241 = (delim
== nullptr ? args
: std::string (args
, delim
- args
));
243 if (nested_cmd
== nullptr)
244 nested_cmd
= skip_spaces (delim
+ 2);
246 std::string org_value
= get_setshow_command_value_string (set_cmd
);
248 /* Tweak the setting to the new temporary value. */
249 do_set_command (temp_value
.c_str (), from_tty
, set_cmd
);
253 scoped_restore save_async
= make_scoped_restore (¤t_ui
->async
, 0);
255 /* Execute the nested command. */
256 execute_command (nested_cmd
, from_tty
);
258 catch (const gdb_exception
&ex
)
260 /* Restore the setting and rethrow. If restoring the setting
261 throws, swallow the new exception and warn. There's nothing
262 else we can reasonably do. */
265 do_set_command (org_value
.c_str (), from_tty
, set_cmd
);
267 catch (const gdb_exception
&ex2
)
269 warning (_("Couldn't restore setting: %s"), ex2
.what ());
275 /* Restore the setting. */
276 do_set_command (org_value
.c_str (), from_tty
, set_cmd
);
279 /* See cli/cli-cmds.h. */
282 with_command_completer_1 (const char *set_cmd_prefix
,
283 completion_tracker
&tracker
,
286 tracker
.set_use_custom_word_point (true);
288 const char *delim
= strstr (text
, "--");
290 /* If we're still not past the "--" delimiter, complete the "with"
291 command as if it was a "set" command. */
294 || !isspace (delim
[-1])
295 || !(isspace (delim
[2]) || delim
[2] == '\0'))
297 std::string new_text
= std::string (set_cmd_prefix
) + text
;
298 tracker
.advance_custom_word_point_by (-(int) strlen (set_cmd_prefix
));
299 complete_nested_command_line (tracker
, new_text
.c_str ());
303 /* We're past the "--" delimiter. Complete on the sub command. */
304 const char *nested_cmd
= skip_spaces (delim
+ 2);
305 tracker
.advance_custom_word_point_by (nested_cmd
- text
);
306 complete_nested_command_line (tracker
, nested_cmd
);
309 /* The "with" command. */
312 with_command (const char *args
, int from_tty
)
314 with_command_1 ("set ", setlist
, args
, from_tty
);
317 /* "with" command completer. */
320 with_command_completer (struct cmd_list_element
*ignore
,
321 completion_tracker
&tracker
,
322 const char *text
, const char * /*word*/)
324 with_command_completer_1 ("set ", tracker
, text
);
328 /* Provide documentation on command or list given by COMMAND. FROM_TTY
332 help_command (const char *command
, int from_tty
)
334 help_cmd (command
, gdb_stdout
);
338 /* Note: The "complete" command is used by Emacs to implement completion.
339 [Is that why this function writes output with *_unfiltered?] */
342 complete_command (const char *arg
, int from_tty
)
346 if (max_completions
== 0)
348 /* Only print this for non-mi frontends. An MI frontend may not
349 be able to handle this. */
350 if (!current_uiout
->is_mi_like_p ())
352 printf_unfiltered (_("max-completions is zero,"
353 " completion is disabled.\n"));
361 int quote_char
= '\0';
364 completion_result result
= complete (arg
, &word
, "e_char
);
366 if (result
.number_matches
!= 0)
368 std::string
arg_prefix (arg
, word
- arg
);
370 if (result
.number_matches
== 1)
371 printf_unfiltered ("%s%s\n", arg_prefix
.c_str (), result
.match_list
[0]);
374 result
.sort_match_list ();
376 for (size_t i
= 0; i
< result
.number_matches
; i
++)
378 printf_unfiltered ("%s%s",
380 result
.match_list
[i
+ 1]);
382 printf_unfiltered ("%c", quote_char
);
383 printf_unfiltered ("\n");
387 if (result
.number_matches
== max_completions
)
389 /* ARG_PREFIX and WORD are included in the output so that emacs
390 will include the message in the output. */
391 printf_unfiltered (_("%s%s %s\n"),
392 arg_prefix
.c_str (), word
,
393 get_max_completions_reached_message ());
399 is_complete_command (struct cmd_list_element
*c
)
401 return cmd_cfunc_eq (c
, complete_command
);
405 show_version (const char *args
, int from_tty
)
407 print_gdb_version (gdb_stdout
, true);
408 printf_filtered ("\n");
412 show_configuration (const char *args
, int from_tty
)
414 print_gdb_configuration (gdb_stdout
);
417 /* Handle the quit command. */
420 quit_command (const char *args
, int from_tty
)
424 /* An optional expression may be used to cause gdb to terminate with
425 the value of that expression. */
428 struct value
*val
= parse_and_eval (args
);
430 exit_code
= (int) value_as_long (val
);
433 if (!quit_confirm ())
434 error (_("Not confirmed."));
436 query_if_trace_running (from_tty
);
438 quit_force (args
? &exit_code
: NULL
, from_tty
);
442 pwd_command (const char *args
, int from_tty
)
445 error (_("The \"pwd\" command does not take an argument: %s"), args
);
447 gdb::unique_xmalloc_ptr
<char> cwd (getcwd (NULL
, 0));
450 error (_("Error finding name of working directory: %s"),
451 safe_strerror (errno
));
453 if (strcmp (cwd
.get (), current_directory
) != 0)
454 printf_unfiltered (_("Working directory %ps\n (canonically %ps).\n"),
455 styled_string (file_name_style
.style (),
457 styled_string (file_name_style
.style (), cwd
.get ()));
459 printf_unfiltered (_("Working directory %ps.\n"),
460 styled_string (file_name_style
.style (),
465 cd_command (const char *dir
, int from_tty
)
468 /* Found something other than leading repetitions of "/..". */
472 /* If the new directory is absolute, repeat is a no-op; if relative,
473 repeat might be useful but is more likely to be a mistake. */
476 gdb::unique_xmalloc_ptr
<char> dir_holder
477 (tilde_expand (dir
!= NULL
? dir
: "~"));
478 dir
= dir_holder
.get ();
481 perror_with_name (dir
);
483 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
484 /* There's too much mess with DOSish names like "d:", "d:.",
485 "d:./foo" etc. Instead of having lots of special #ifdef'ed code,
486 simply get the canonicalized name of the current directory. */
487 gdb::unique_xmalloc_ptr
<char> cwd (getcwd (NULL
, 0));
492 if (IS_DIR_SEPARATOR (dir
[len
- 1]))
494 /* Remove the trailing slash unless this is a root directory
495 (including a drive letter on non-Unix systems). */
496 if (!(len
== 1) /* "/" */
497 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
498 && !(len
== 3 && dir
[1] == ':') /* "d:/" */
504 dir_holder
.reset (savestring (dir
, len
));
505 if (IS_ABSOLUTE_PATH (dir_holder
.get ()))
507 xfree (current_directory
);
508 current_directory
= dir_holder
.release ();
512 if (IS_DIR_SEPARATOR (current_directory
[strlen (current_directory
) - 1]))
513 current_directory
= concat (current_directory
, dir_holder
.get (),
516 current_directory
= concat (current_directory
, SLASH_STRING
,
517 dir_holder
.get (), (char *) NULL
);
520 /* Now simplify any occurrences of `.' and `..' in the pathname. */
523 for (p
= current_directory
; *p
;)
525 if (IS_DIR_SEPARATOR (p
[0]) && p
[1] == '.'
526 && (p
[2] == 0 || IS_DIR_SEPARATOR (p
[2])))
527 memmove (p
, p
+ 2, strlen (p
+ 2) + 1);
528 else if (IS_DIR_SEPARATOR (p
[0]) && p
[1] == '.' && p
[2] == '.'
529 && (p
[3] == 0 || IS_DIR_SEPARATOR (p
[3])))
533 /* Search backwards for the directory just before the "/.."
534 and obliterate it and the "/..". */
537 while (q
!= current_directory
&& !IS_DIR_SEPARATOR (q
[-1]))
540 if (q
== current_directory
)
541 /* current_directory is
542 a relative pathname ("can't happen"--leave it alone). */
546 memmove (q
- 1, p
+ 3, strlen (p
+ 3) + 1);
551 /* We are dealing with leading repetitions of "/..", for
552 example "/../..", which is the Mach super-root. */
562 forget_cached_source_info ();
565 pwd_command ((char *) 0, 1);
568 /* Show the current value of the 'script-extension' option. */
571 show_script_ext_mode (struct ui_file
*file
, int from_tty
,
572 struct cmd_list_element
*c
, const char *value
)
574 fprintf_filtered (file
,
575 _("Script filename extension recognition is \"%s\".\n"),
579 /* Try to open SCRIPT_FILE.
580 If successful, the full path name is stored in *FULL_PATHP,
581 and the stream is returned.
582 If not successful, return NULL; errno is set for the last file
585 If SEARCH_PATH is non-zero, and the file isn't found in cwd,
586 search for it in the source search path. */
588 gdb::optional
<open_script
>
589 find_and_open_script (const char *script_file
, int search_path
)
592 openp_flags search_flags
= OPF_TRY_CWD_FIRST
| OPF_RETURN_REALPATH
;
593 gdb::optional
<open_script
> opened
;
595 gdb::unique_xmalloc_ptr
<char> file (tilde_expand (script_file
));
598 search_flags
|= OPF_SEARCH_IN_PATH
;
600 /* Search for and open 'file' on the search path used for source
601 files. Put the full location in *FULL_PATHP. */
602 gdb::unique_xmalloc_ptr
<char> full_path
;
603 fd
= openp (source_path
, search_flags
,
604 file
.get (), O_RDONLY
, &full_path
);
609 FILE *result
= fdopen (fd
, FOPEN_RT
);
612 int save_errno
= errno
;
618 opened
.emplace (gdb_file_up (result
), std::move (full_path
));
623 /* Load script FILE, which has already been opened as STREAM.
624 FILE_TO_OPEN is the form of FILE to use if one needs to open the file.
625 This is provided as FILE may have been found via the source search path.
626 An important thing to note here is that FILE may be a symlink to a file
627 with a different or non-existing suffix, and thus one cannot infer the
628 extension language from FILE_TO_OPEN. */
631 source_script_from_stream (FILE *stream
, const char *file
,
632 const char *file_to_open
)
634 if (script_ext_mode
!= script_ext_off
)
636 const struct extension_language_defn
*extlang
637 = get_ext_lang_of_file (file
);
641 if (ext_lang_present_p (extlang
))
643 script_sourcer_func
*sourcer
644 = ext_lang_script_sourcer (extlang
);
646 gdb_assert (sourcer
!= NULL
);
647 sourcer (extlang
, stream
, file_to_open
);
650 else if (script_ext_mode
== script_ext_soft
)
652 /* Assume the file is a gdb script.
653 This is handled below. */
656 throw_ext_lang_unsupported (extlang
);
660 script_from_file (stream
, file
);
663 /* Worker to perform the "source" command.
665 If SEARCH_PATH is non-zero, and the file isn't found in cwd,
666 search for it in the source search path. */
669 source_script_with_search (const char *file
, int from_tty
, int search_path
)
672 if (file
== NULL
|| *file
== 0)
673 error (_("source command requires file name of file to source."));
675 gdb::optional
<open_script
> opened
= find_and_open_script (file
, search_path
);
678 /* The script wasn't found, or was otherwise inaccessible.
679 If the source command was invoked interactively, throw an
680 error. Otherwise (e.g. if it was invoked by a script),
681 just emit a warning, rather than cause an error. */
683 perror_with_name (file
);
686 perror_warning_with_name (file
);
691 /* The python support reopens the file, so we need to pass full_path here
692 in case the file was found on the search path. It's useful to do this
693 anyway so that error messages show the actual file used. But only do
694 this if we (may have) used search_path, as printing the full path in
695 errors for the non-search case can be more noise than signal. */
696 source_script_from_stream (opened
->stream
.get (), file
,
697 search_path
? opened
->full_path
.get () : file
);
700 /* Wrapper around source_script_with_search to export it to main.c
701 for use in loading .gdbinit scripts. */
704 source_script (const char *file
, int from_tty
)
706 source_script_with_search (file
, from_tty
, 0);
710 source_command (const char *args
, int from_tty
)
712 const char *file
= args
;
715 scoped_restore save_source_verbose
= make_scoped_restore (&source_verbose
);
717 /* -v causes the source command to run in verbose mode.
718 -s causes the file to be searched in the source search path,
719 even if the file name contains a '/'.
720 We still have to be able to handle filenames with spaces in a
721 backward compatible way, so buildargv is not appropriate. */
725 while (args
[0] != '\0')
727 /* Make sure leading white space does not break the
729 args
= skip_spaces (args
);
734 if (args
[1] == 'v' && isspace (args
[2]))
738 /* Skip passed -v. */
741 else if (args
[1] == 's' && isspace (args
[2]))
745 /* Skip passed -s. */
752 file
= skip_spaces (args
);
755 source_script_with_search (file
, from_tty
, search_path
);
760 echo_command (const char *text
, int from_tty
)
762 const char *p
= text
;
766 while ((c
= *p
++) != '\0')
770 /* \ at end of argument is used after spaces
771 so they won't be lost. */
775 c
= parse_escape (get_current_arch (), &p
);
777 printf_filtered ("%c", c
);
780 printf_filtered ("%c", c
);
783 reset_terminal_style (gdb_stdout
);
785 /* Force this output to appear now. */
787 gdb_flush (gdb_stdout
);
790 /* Sets the last launched shell command convenience variables based on
794 exit_status_set_internal_vars (int exit_status
)
796 struct internalvar
*var_code
= lookup_internalvar ("_shell_exitcode");
797 struct internalvar
*var_signal
= lookup_internalvar ("_shell_exitsignal");
799 clear_internalvar (var_code
);
800 clear_internalvar (var_signal
);
801 if (WIFEXITED (exit_status
))
802 set_internalvar_integer (var_code
, WEXITSTATUS (exit_status
));
803 else if (WIFSIGNALED (exit_status
))
804 set_internalvar_integer (var_signal
, WTERMSIG (exit_status
));
806 warning (_("unexpected shell command exit status %d"), exit_status
);
810 shell_escape (const char *arg
, int from_tty
)
812 #if defined(CANT_FORK) || \
813 (!defined(HAVE_WORKING_VFORK) && !defined(HAVE_WORKING_FORK))
814 /* If ARG is NULL, they want an inferior shell, but `system' just
815 reports if the shell is available when passed a NULL arg. */
816 int rc
= system (arg
? arg
: "");
819 arg
= "inferior shell";
822 fprintf_unfiltered (gdb_stderr
, "Cannot execute %s: %s\n", arg
,
823 safe_strerror (errno
));
825 fprintf_unfiltered (gdb_stderr
, "%s exited with status %d\n", arg
, rc
);
827 /* Make sure to return to the directory GDB thinks it is, in case
828 the shell command we just ran changed it. */
829 chdir (current_directory
);
830 exit_status_set_internal_vars (rc
);
832 #else /* Can fork. */
835 if ((pid
= vfork ()) == 0)
837 const char *p
, *user_shell
= get_shell ();
841 /* Get the name of the shell for arg0. */
842 p
= lbasename (user_shell
);
845 execl (user_shell
, p
, (char *) 0);
847 execl (user_shell
, p
, "-c", arg
, (char *) 0);
849 fprintf_unfiltered (gdb_stderr
, "Cannot execute %s: %s\n", user_shell
,
850 safe_strerror (errno
));
855 waitpid (pid
, &status
, 0);
857 error (_("Fork failed"));
858 exit_status_set_internal_vars (status
);
859 #endif /* Can fork. */
862 /* Implementation of the "shell" command. */
865 shell_command (const char *arg
, int from_tty
)
867 shell_escape (arg
, from_tty
);
871 edit_command (const char *arg
, int from_tty
)
873 struct symtab_and_line sal
;
879 /* Pull in the current default source line if necessary. */
882 set_default_source_symtab_and_line ();
883 sal
= get_current_source_symtab_and_line ();
886 /* Bare "edit" edits file with present line. */
891 error (_("No default source file yet."));
892 sal
.line
+= get_lines_to_list () / 2;
898 /* Now should only be one argument -- decode it in SAL. */
900 event_location_up location
= string_to_event_location (&arg1
,
902 std::vector
<symtab_and_line
> sals
= decode_line_1 (location
.get (),
903 DECODE_LINE_LIST_MODE
,
912 if (sals
.size () > 1)
914 ambiguous_line_spec (sals
,
915 _("Specified line is ambiguous:\n"));
922 error (_("Junk at end of line specification."));
924 /* If line was specified by address, first print exactly which
925 line, and which file. In this case, sal.symtab == 0 means
926 address is outside of all known source files, not that user
927 failed to give a filename. */
930 struct gdbarch
*gdbarch
;
933 error (_("No source file for address %s."),
934 paddress (get_current_arch (), sal
.pc
));
936 gdbarch
= get_objfile_arch (SYMTAB_OBJFILE (sal
.symtab
));
937 sym
= find_pc_function (sal
.pc
);
939 printf_filtered ("%s is in %s (%s:%d).\n",
940 paddress (gdbarch
, sal
.pc
),
942 symtab_to_filename_for_display (sal
.symtab
),
945 printf_filtered ("%s is at %s:%d.\n",
946 paddress (gdbarch
, sal
.pc
),
947 symtab_to_filename_for_display (sal
.symtab
),
951 /* If what was given does not imply a symtab, it must be an
952 undebuggable symbol which means no source code. */
955 error (_("No line number known for %s."), arg
);
958 if ((editor
= getenv ("EDITOR")) == NULL
)
961 fn
= symtab_to_fullname (sal
.symtab
);
963 /* Quote the file name, in case it has whitespace or other special
965 p
= xstrprintf ("%s +%d \"%s\"", editor
, sal
.line
, fn
);
966 shell_escape (p
, from_tty
);
970 /* The options for the "pipe" command. */
975 char *delimiter
= nullptr;
983 static const gdb::option::option_def pipe_cmd_option_defs
[] = {
985 gdb::option::string_option_def
<pipe_cmd_opts
> {
987 [] (pipe_cmd_opts
*opts
) { return &opts
->delimiter
; },
989 N_("Indicates to use the specified delimiter string to separate\n\
990 COMMAND from SHELL_COMMAND, in alternative to |. This is useful in\n\
991 case COMMAND contains a | character."),
996 /* Create an option_def_group for the "pipe" command's options, with
999 static inline gdb::option::option_def_group
1000 make_pipe_cmd_options_def_group (pipe_cmd_opts
*opts
)
1002 return {{pipe_cmd_option_defs
}, opts
};
1005 /* Implementation of the "pipe" command. */
1008 pipe_command (const char *arg
, int from_tty
)
1012 auto grp
= make_pipe_cmd_options_def_group (&opts
);
1013 gdb::option::process_options
1014 (&arg
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
1016 const char *delim
= "|";
1017 if (opts
.delimiter
!= nullptr)
1018 delim
= opts
.delimiter
;
1020 const char *command
= arg
;
1021 if (command
== nullptr)
1022 error (_("Missing COMMAND"));
1024 arg
= strstr (arg
, delim
);
1027 error (_("Missing delimiter before SHELL_COMMAND"));
1029 std::string
gdb_cmd (command
, arg
- command
);
1031 arg
+= strlen (delim
); /* Skip the delimiter. */
1033 if (gdb_cmd
.empty ())
1034 gdb_cmd
= repeat_previous ();
1036 const char *shell_command
= skip_spaces (arg
);
1037 if (*shell_command
== '\0')
1038 error (_("Missing SHELL_COMMAND"));
1040 FILE *to_shell_command
= popen (shell_command
, "w");
1042 if (to_shell_command
== nullptr)
1043 error (_("Error launching \"%s\""), shell_command
);
1047 stdio_file
pipe_file (to_shell_command
);
1049 execute_command_to_ui_file (&pipe_file
, gdb_cmd
.c_str (), from_tty
);
1053 pclose (to_shell_command
);
1057 int exit_status
= pclose (to_shell_command
);
1059 if (exit_status
< 0)
1060 error (_("shell command \"%s\" failed: %s"), shell_command
,
1061 safe_strerror (errno
));
1062 exit_status_set_internal_vars (exit_status
);
1065 /* Completer for the pipe command. */
1068 pipe_command_completer (struct cmd_list_element
*ignore
,
1069 completion_tracker
&tracker
,
1070 const char *text
, const char *word_ignored
)
1074 const char *org_text
= text
;
1075 auto grp
= make_pipe_cmd_options_def_group (&opts
);
1076 if (gdb::option::complete_options
1077 (tracker
, &text
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
))
1080 const char *delimiter
= "|";
1081 if (opts
.delimiter
!= nullptr)
1082 delimiter
= opts
.delimiter
;
1084 /* Check if we're past option values already. */
1085 if (text
> org_text
&& !isspace (text
[-1]))
1088 const char *delim
= strstr (text
, delimiter
);
1090 /* If we're still not past the delimiter, complete the gdb
1092 if (delim
== nullptr || delim
== text
)
1094 complete_nested_command_line (tracker
, text
);
1098 /* We're past the delimiter. What follows is a shell command, which
1099 we don't know how to complete. */
1103 list_command (const char *arg
, int from_tty
)
1110 int linenum_beg
= 0;
1113 /* Pull in the current default source line if necessary. */
1114 if (arg
== NULL
|| ((arg
[0] == '+' || arg
[0] == '-') && arg
[1] == '\0'))
1116 set_default_source_symtab_and_line ();
1117 symtab_and_line cursal
= get_current_source_symtab_and_line ();
1119 /* If this is the first "list" since we've set the current
1120 source line, center the listing around that line. */
1121 if (get_first_line_listed () == 0)
1125 first
= std::max (cursal
.line
- get_lines_to_list () / 2, 1);
1127 /* A small special case --- if listing backwards, and we
1128 should list only one line, list the preceding line,
1129 instead of the exact line we've just shown after e.g.,
1130 stopping for a breakpoint. */
1131 if (arg
!= NULL
&& arg
[0] == '-'
1132 && get_lines_to_list () == 1 && first
> 1)
1135 print_source_lines (cursal
.symtab
, source_lines_range (first
), 0);
1138 /* "l" or "l +" lists next ten lines. */
1139 else if (arg
== NULL
|| arg
[0] == '+')
1140 print_source_lines (cursal
.symtab
,
1141 source_lines_range (cursal
.line
), 0);
1143 /* "l -" lists previous ten lines, the ones before the ten just
1145 else if (arg
[0] == '-')
1147 if (get_first_line_listed () == 1)
1148 error (_("Already at the start of %s."),
1149 symtab_to_filename_for_display (cursal
.symtab
));
1150 source_lines_range
range (get_first_line_listed (),
1151 source_lines_range::BACKWARD
);
1152 print_source_lines (cursal
.symtab
, range
, 0);
1158 /* Now if there is only one argument, decode it in SAL
1160 If there are two arguments, decode them in SAL and SAL_END
1161 and clear NO_END; however, if one of the arguments is blank,
1162 set DUMMY_BEG or DUMMY_END to record that fact. */
1164 if (!have_full_symbols () && !have_partial_symbols ())
1165 error (_("No symbol table is loaded. Use the \"file\" command."));
1167 std::vector
<symtab_and_line
> sals
;
1168 symtab_and_line sal
, sal_end
;
1175 event_location_up location
= string_to_event_location (&arg1
,
1177 sals
= decode_line_1 (location
.get (), DECODE_LINE_LIST_MODE
,
1189 /* Record whether the BEG arg is all digits. */
1191 for (p
= arg
; p
!= arg1
&& *p
>= '0' && *p
<= '9'; p
++);
1192 linenum_beg
= (p
== arg1
);
1194 /* Save the range of the first argument, in case we need to let the
1195 user know it was ambiguous. */
1196 const char *beg
= arg
;
1197 size_t beg_len
= arg1
- beg
;
1199 while (*arg1
== ' ' || *arg1
== '\t')
1204 if (sals
.size () > 1)
1206 ambiguous_line_spec (sals
,
1207 _("Specified first line '%.*s' is ambiguous:\n"),
1208 (int) beg_len
, beg
);
1212 while (*arg1
== ' ' || *arg1
== '\t')
1218 /* Save the last argument, in case we need to let the user
1219 know it was ambiguous. */
1220 const char *end_arg
= arg1
;
1222 event_location_up location
1223 = string_to_event_location (&arg1
, current_language
);
1225 std::vector
<symtab_and_line
> sals_end
1227 ? decode_line_1 (location
.get (), DECODE_LINE_LIST_MODE
,
1229 : decode_line_1 (location
.get (), DECODE_LINE_LIST_MODE
,
1230 NULL
, sal
.symtab
, sal
.line
));
1232 filter_sals (sals_end
);
1233 if (sals_end
.empty ())
1235 if (sals_end
.size () > 1)
1237 ambiguous_line_spec (sals_end
,
1238 _("Specified last line '%s' is ambiguous:\n"),
1242 sal_end
= sals_end
[0];
1247 error (_("Junk at end of line specification."));
1249 if (!no_end
&& !dummy_beg
&& !dummy_end
1250 && sal
.symtab
!= sal_end
.symtab
)
1251 error (_("Specified first and last lines are in different files."));
1252 if (dummy_beg
&& dummy_end
)
1253 error (_("Two empty args do not say what lines to list."));
1255 /* If line was specified by address,
1256 first print exactly which line, and which file.
1258 In this case, sal.symtab == 0 means address is outside of all
1259 known source files, not that user failed to give a filename. */
1262 struct gdbarch
*gdbarch
;
1264 if (sal
.symtab
== 0)
1265 error (_("No source file for address %s."),
1266 paddress (get_current_arch (), sal
.pc
));
1268 gdbarch
= get_objfile_arch (SYMTAB_OBJFILE (sal
.symtab
));
1269 sym
= find_pc_function (sal
.pc
);
1271 printf_filtered ("%s is in %s (%s:%d).\n",
1272 paddress (gdbarch
, sal
.pc
),
1274 symtab_to_filename_for_display (sal
.symtab
), sal
.line
);
1276 printf_filtered ("%s is at %s:%d.\n",
1277 paddress (gdbarch
, sal
.pc
),
1278 symtab_to_filename_for_display (sal
.symtab
), sal
.line
);
1281 /* If line was not specified by just a line number, and it does not
1282 imply a symtab, it must be an undebuggable symbol which means no
1285 if (!linenum_beg
&& sal
.symtab
== 0)
1286 error (_("No line number known for %s."), arg
);
1288 /* If this command is repeated with RET,
1289 turn it into the no-arg variant. */
1292 set_repeat_arguments ("");
1294 if (dummy_beg
&& sal_end
.symtab
== 0)
1295 error (_("No default source file yet. Do \"help list\"."));
1298 source_lines_range
range (sal_end
.line
+ 1,
1299 source_lines_range::BACKWARD
);
1300 print_source_lines (sal_end
.symtab
, range
, 0);
1302 else if (sal
.symtab
== 0)
1303 error (_("No default source file yet. Do \"help list\"."));
1306 for (int i
= 0; i
< sals
.size (); i
++)
1309 int first_line
= sal
.line
- get_lines_to_list () / 2;
1312 if (sals
.size () > 1)
1313 print_sal_location (sal
);
1314 print_source_lines (sal
.symtab
, source_lines_range (first_line
), 0);
1318 print_source_lines (sal
.symtab
, source_lines_range (sal
.line
), 0);
1320 print_source_lines (sal
.symtab
,
1321 source_lines_range (sal
.line
, (sal_end
.line
+ 1)),
1325 /* Subroutine of disassemble_command to simplify it.
1326 Perform the disassembly.
1327 NAME is the name of the function if known, or NULL.
1328 [LOW,HIGH) are the range of addresses to disassemble.
1329 BLOCK is the block to disassemble; it needs to be provided
1330 when non-contiguous blocks are disassembled; otherwise
1332 MIXED is non-zero to print source with the assembler. */
1335 print_disassembly (struct gdbarch
*gdbarch
, const char *name
,
1336 CORE_ADDR low
, CORE_ADDR high
,
1337 const struct block
*block
,
1338 gdb_disassembly_flags flags
)
1341 if (tui_is_window_visible (DISASSEM_WIN
))
1342 tui_show_assembly (gdbarch
, low
);
1346 printf_filtered ("Dump of assembler code ");
1348 printf_filtered ("for function %s:\n", name
);
1349 if (block
== nullptr || BLOCK_CONTIGUOUS_P (block
))
1352 printf_filtered ("from %s to %s:\n",
1353 paddress (gdbarch
, low
), paddress (gdbarch
, high
));
1355 /* Dump the specified range. */
1356 gdb_disassembly (gdbarch
, current_uiout
, flags
, -1, low
, high
);
1360 for (int i
= 0; i
< BLOCK_NRANGES (block
); i
++)
1362 CORE_ADDR range_low
= BLOCK_RANGE_START (block
, i
);
1363 CORE_ADDR range_high
= BLOCK_RANGE_END (block
, i
);
1364 printf_filtered (_("Address range %s to %s:\n"),
1365 paddress (gdbarch
, range_low
),
1366 paddress (gdbarch
, range_high
));
1367 gdb_disassembly (gdbarch
, current_uiout
, flags
, -1,
1368 range_low
, range_high
);
1371 printf_filtered ("End of assembler dump.\n");
1375 /* Subroutine of disassemble_command to simplify it.
1376 Print a disassembly of the current function according to FLAGS. */
1379 disassemble_current_function (gdb_disassembly_flags flags
)
1381 struct frame_info
*frame
;
1382 struct gdbarch
*gdbarch
;
1383 CORE_ADDR low
, high
, pc
;
1385 const struct block
*block
;
1387 frame
= get_selected_frame (_("No frame selected."));
1388 gdbarch
= get_frame_arch (frame
);
1389 pc
= get_frame_address_in_block (frame
);
1390 if (find_pc_partial_function (pc
, &name
, &low
, &high
, &block
) == 0)
1391 error (_("No function contains program counter for selected frame."));
1393 /* NOTE: cagney/2003-02-13 The `tui_active' was previously
1396 /* FIXME: cagney/2004-02-07: This should be an observer. */
1397 low
= tui_get_low_disassembly_address (gdbarch
, low
, pc
);
1399 low
+= gdbarch_deprecated_function_start_offset (gdbarch
);
1401 print_disassembly (gdbarch
, name
, low
, high
, block
, flags
);
1404 /* Dump a specified section of assembly code.
1408 - dump the assembly code for the function of the current pc
1409 disassemble [/mrs] addr
1410 - dump the assembly code for the function at ADDR
1411 disassemble [/mrs] low,high
1412 disassemble [/mrs] low,+length
1413 - dump the assembly code in the range [LOW,HIGH), or [LOW,LOW+length)
1415 A /m modifier will include source code with the assembly in a
1416 "source centric" view. This view lists only the file of the first insn,
1417 even if other source files are involved (e.g., inlined functions), and
1418 the output is in source order, even with optimized code. This view is
1419 considered deprecated as it hasn't been useful in practice.
1421 A /r modifier will include raw instructions in hex with the assembly.
1423 A /s modifier will include source code with the assembly, like /m, with
1424 two important differences:
1425 1) The output is still in pc address order.
1426 2) File names and contents for all relevant source files are displayed. */
1429 disassemble_command (const char *arg
, int from_tty
)
1431 struct gdbarch
*gdbarch
= get_current_arch ();
1432 CORE_ADDR low
, high
;
1435 gdb_disassembly_flags flags
;
1437 const struct block
*block
= nullptr;
1448 error (_("Missing modifier."));
1450 while (*p
&& ! isspace (*p
))
1455 flags
|= DISASSEMBLY_SOURCE_DEPRECATED
;
1458 flags
|= DISASSEMBLY_RAW_INSN
;
1461 flags
|= DISASSEMBLY_SOURCE
;
1464 error (_("Invalid disassembly modifier."));
1468 p
= skip_spaces (p
);
1471 if ((flags
& (DISASSEMBLY_SOURCE_DEPRECATED
| DISASSEMBLY_SOURCE
))
1472 == (DISASSEMBLY_SOURCE_DEPRECATED
| DISASSEMBLY_SOURCE
))
1473 error (_("Cannot specify both /m and /s."));
1477 flags
|= DISASSEMBLY_OMIT_FNAME
;
1478 disassemble_current_function (flags
);
1482 pc
= value_as_address (parse_to_comma_and_eval (&p
));
1488 if (find_pc_partial_function (pc
, &name
, &low
, &high
, &block
) == 0)
1489 error (_("No function contains specified address."));
1491 /* NOTE: cagney/2003-02-13 The `tui_active' was previously
1494 /* FIXME: cagney/2004-02-07: This should be an observer. */
1495 low
= tui_get_low_disassembly_address (gdbarch
, low
, pc
);
1497 low
+= gdbarch_deprecated_function_start_offset (gdbarch
);
1498 flags
|= DISASSEMBLY_OMIT_FNAME
;
1502 /* Two arguments. */
1505 p
= skip_spaces (p
);
1511 high
= parse_and_eval_address (p
);
1516 print_disassembly (gdbarch
, name
, low
, high
, block
, flags
);
1520 make_command (const char *arg
, int from_tty
)
1523 shell_escape ("make", from_tty
);
1526 std::string cmd
= std::string ("make ") + arg
;
1528 shell_escape (cmd
.c_str (), from_tty
);
1533 show_user (const char *args
, int from_tty
)
1535 struct cmd_list_element
*c
;
1539 const char *comname
= args
;
1541 c
= lookup_cmd (&comname
, cmdlist
, "", 0, 1);
1542 if (!cli_user_command_p (c
))
1543 error (_("Not a user command."));
1544 show_user_1 (c
, "", args
, gdb_stdout
);
1548 for (c
= cmdlist
; c
; c
= c
->next
)
1550 if (cli_user_command_p (c
) || c
->prefixlist
!= NULL
)
1551 show_user_1 (c
, "", c
->name
, gdb_stdout
);
1556 /* Search through names of commands and documentations for a certain
1557 regular expression. */
1560 apropos_command (const char *arg
, int from_tty
)
1562 bool verbose
= arg
&& check_for_argument (&arg
, "-v", 2);
1564 if (arg
== NULL
|| *arg
== '\0')
1565 error (_("REGEXP string is empty"));
1567 compiled_regex
pattern (arg
, REG_ICASE
,
1568 _("Error in regular expression"));
1570 apropos_cmd (gdb_stdout
, cmdlist
, verbose
, pattern
, "");
1573 /* Subroutine of alias_command to simplify it.
1574 Return the first N elements of ARGV flattened back to a string
1575 with a space separating each element.
1576 ARGV may not be NULL.
1577 This does not take care of quoting elements in case they contain spaces
1581 argv_to_string (char **argv
, int n
)
1586 gdb_assert (argv
!= NULL
);
1587 gdb_assert (n
>= 0 && n
<= countargv (argv
));
1589 for (i
= 0; i
< n
; ++i
)
1599 /* Subroutine of alias_command to simplify it.
1600 Return true if COMMAND exists, unambiguously. Otherwise false. */
1603 valid_command_p (const char *command
)
1605 struct cmd_list_element
*c
;
1607 c
= lookup_cmd_1 (& command
, cmdlist
, NULL
, 1);
1609 if (c
== NULL
|| c
== (struct cmd_list_element
*) -1)
1612 /* This is the slightly tricky part.
1613 lookup_cmd_1 will return a pointer to the last part of COMMAND
1614 to match, leaving COMMAND pointing at the remainder. */
1615 while (*command
== ' ' || *command
== '\t')
1617 return *command
== '\0';
1620 /* Called when "alias" was incorrectly used. */
1623 alias_usage_error (void)
1625 error (_("Usage: alias [-a] [--] ALIAS = COMMAND"));
1628 /* Make an alias of an existing command. */
1631 alias_command (const char *args
, int from_tty
)
1633 int i
, alias_argc
, command_argc
;
1634 int abbrev_flag
= 0;
1636 const char *alias
, *command
;
1638 if (args
== NULL
|| strchr (args
, '=') == NULL
)
1639 alias_usage_error ();
1641 equals
= strchr (args
, '=');
1642 std::string
args2 (args
, equals
- args
);
1644 gdb_argv
built_alias_argv (args2
.c_str ());
1645 gdb_argv
command_argv (equals
+ 1);
1647 char **alias_argv
= built_alias_argv
.get ();
1648 while (alias_argv
[0] != NULL
)
1650 if (strcmp (alias_argv
[0], "-a") == 0)
1655 else if (strcmp (alias_argv
[0], "--") == 0)
1664 if (alias_argv
[0] == NULL
|| command_argv
[0] == NULL
1665 || *alias_argv
[0] == '\0' || *command_argv
[0] == '\0')
1666 alias_usage_error ();
1668 for (i
= 0; alias_argv
[i
] != NULL
; ++i
)
1670 if (! valid_user_defined_cmd_name_p (alias_argv
[i
]))
1673 error (_("Invalid command name: %s"), alias_argv
[i
]);
1675 error (_("Invalid command element name: %s"), alias_argv
[i
]);
1679 alias_argc
= countargv (alias_argv
);
1680 command_argc
= command_argv
.count ();
1682 /* COMMAND must exist.
1683 Reconstruct the command to remove any extraneous spaces,
1684 for better error messages. */
1685 std::string
command_string (argv_to_string (command_argv
.get (),
1687 command
= command_string
.c_str ();
1688 if (! valid_command_p (command
))
1689 error (_("Invalid command to alias to: %s"), command
);
1691 /* ALIAS must not exist. */
1692 std::string
alias_string (argv_to_string (alias_argv
, alias_argc
));
1693 alias
= alias_string
.c_str ();
1694 if (valid_command_p (alias
))
1695 error (_("Alias already exists: %s"), alias
);
1697 /* If ALIAS is one word, it is an alias for the entire COMMAND.
1698 Example: alias spe = set print elements
1700 Otherwise ALIAS and COMMAND must have the same number of words,
1701 and every word except the last must identify the same prefix command;
1702 and the last word of ALIAS is made an alias of the last word of COMMAND.
1703 Example: alias set print elms = set pr elem
1704 Note that unambiguous abbreviations are allowed. */
1706 if (alias_argc
== 1)
1708 /* add_cmd requires *we* allocate space for name, hence the xstrdup. */
1709 add_com_alias (xstrdup (alias_argv
[0]), command
, class_alias
,
1714 const char *alias_prefix
, *command_prefix
;
1715 struct cmd_list_element
*c_alias
, *c_command
;
1717 if (alias_argc
!= command_argc
)
1718 error (_("Mismatched command length between ALIAS and COMMAND."));
1720 /* Create copies of ALIAS and COMMAND without the last word,
1721 and use that to verify the leading elements give the same
1723 std::string
alias_prefix_string (argv_to_string (alias_argv
,
1725 std::string
command_prefix_string (argv_to_string (command_argv
.get (),
1727 alias_prefix
= alias_prefix_string
.c_str ();
1728 command_prefix
= command_prefix_string
.c_str ();
1730 c_command
= lookup_cmd_1 (& command_prefix
, cmdlist
, NULL
, 1);
1731 /* We've already tried to look up COMMAND. */
1732 gdb_assert (c_command
!= NULL
1733 && c_command
!= (struct cmd_list_element
*) -1);
1734 gdb_assert (c_command
->prefixlist
!= NULL
);
1735 c_alias
= lookup_cmd_1 (& alias_prefix
, cmdlist
, NULL
, 1);
1736 if (c_alias
!= c_command
)
1737 error (_("ALIAS and COMMAND prefixes do not match."));
1739 /* add_cmd requires *we* allocate space for name, hence the xstrdup. */
1740 add_alias_cmd (xstrdup (alias_argv
[alias_argc
- 1]),
1741 command_argv
[command_argc
- 1],
1742 class_alias
, abbrev_flag
, c_command
->prefixlist
);
1746 /* Print the file / line number / symbol name of the location
1747 specified by SAL. */
1750 print_sal_location (const symtab_and_line
&sal
)
1752 scoped_restore_current_program_space restore_pspace
;
1753 set_current_program_space (sal
.pspace
);
1755 const char *sym_name
= NULL
;
1756 if (sal
.symbol
!= NULL
)
1757 sym_name
= sal
.symbol
->print_name ();
1758 printf_filtered (_("file: \"%s\", line number: %d, symbol: \"%s\"\n"),
1759 symtab_to_filename_for_display (sal
.symtab
),
1760 sal
.line
, sym_name
!= NULL
? sym_name
: "???");
1763 /* Print a list of files and line numbers which a user may choose from
1764 in order to list a function which was specified ambiguously (as
1765 with `list classname::overloadedfuncname', for example). The SALS
1766 array provides the filenames and line numbers. FORMAT is a
1767 printf-style format string used to tell the user what was
1771 ambiguous_line_spec (gdb::array_view
<const symtab_and_line
> sals
,
1772 const char *format
, ...)
1775 va_start (ap
, format
);
1776 vprintf_filtered (format
, ap
);
1779 for (const auto &sal
: sals
)
1780 print_sal_location (sal
);
1783 /* Comparison function for filter_sals. Returns a qsort-style
1787 cmp_symtabs (const symtab_and_line
&sala
, const symtab_and_line
&salb
)
1789 const char *dira
= SYMTAB_DIRNAME (sala
.symtab
);
1790 const char *dirb
= SYMTAB_DIRNAME (salb
.symtab
);
1798 else if (dirb
== NULL
)
1805 r
= filename_cmp (dira
, dirb
);
1810 r
= filename_cmp (sala
.symtab
->filename
, salb
.symtab
->filename
);
1814 if (sala
.line
< salb
.line
)
1816 return sala
.line
== salb
.line
? 0 : 1;
1819 /* Remove any SALs that do not match the current program space, or
1820 which appear to be "file:line" duplicates. */
1823 filter_sals (std::vector
<symtab_and_line
> &sals
)
1825 /* Remove SALs that do not match. */
1826 auto from
= std::remove_if (sals
.begin (), sals
.end (),
1827 [&] (const symtab_and_line
&sal
)
1828 { return (sal
.pspace
!= current_program_space
|| sal
.symtab
== NULL
); });
1831 std::sort (sals
.begin (), from
,
1832 [] (const symtab_and_line
&sala
, const symtab_and_line
&salb
)
1833 { return cmp_symtabs (sala
, salb
) < 0; });
1835 from
= std::unique (sals
.begin (), from
,
1836 [&] (const symtab_and_line
&sala
,
1837 const symtab_and_line
&salb
)
1838 { return cmp_symtabs (sala
, salb
) == 0; });
1840 sals
.erase (from
, sals
.end ());
1844 set_debug (const char *arg
, int from_tty
)
1846 printf_unfiltered (_("\"set debug\" must be followed by "
1847 "the name of a debug subcommand.\n"));
1848 help_list (setdebuglist
, "set debug ", all_commands
, gdb_stdout
);
1852 show_debug (const char *args
, int from_tty
)
1854 cmd_show_list (showdebuglist
, from_tty
, "");
1858 init_cmd_lists (void)
1860 max_user_call_depth
= 1024;
1864 show_info_verbose (struct ui_file
*file
, int from_tty
,
1865 struct cmd_list_element
*c
,
1869 fprintf_filtered (file
,
1870 _("Verbose printing of informational messages is %s.\n"),
1873 fprintf_filtered (file
, _("Verbosity is %s.\n"), value
);
1877 show_history_expansion_p (struct ui_file
*file
, int from_tty
,
1878 struct cmd_list_element
*c
, const char *value
)
1880 fprintf_filtered (file
, _("History expansion on command input is %s.\n"),
1885 show_remote_debug (struct ui_file
*file
, int from_tty
,
1886 struct cmd_list_element
*c
, const char *value
)
1888 fprintf_filtered (file
, _("Debugging of remote protocol is %s.\n"),
1893 show_remote_timeout (struct ui_file
*file
, int from_tty
,
1894 struct cmd_list_element
*c
, const char *value
)
1896 fprintf_filtered (file
,
1897 _("Timeout limit to wait for target to respond is %s.\n"),
1902 show_max_user_call_depth (struct ui_file
*file
, int from_tty
,
1903 struct cmd_list_element
*c
, const char *value
)
1905 fprintf_filtered (file
,
1906 _("The max call depth for user-defined commands is %s.\n"),
1910 /* Returns the cmd_list_element in SHOWLIST corresponding to the first
1911 argument of ARGV, which must contain one single value.
1912 Throws an error if no value provided, or value not correct.
1913 FNNAME is used in the error message. */
1915 static cmd_list_element
*
1916 setting_cmd (const char *fnname
, struct cmd_list_element
*showlist
,
1917 int argc
, struct value
**argv
)
1920 error (_("You must provide an argument to %s"), fnname
);
1922 error (_("You can only provide one argument to %s"), fnname
);
1924 struct type
*type0
= check_typedef (value_type (argv
[0]));
1926 if (TYPE_CODE (type0
) != TYPE_CODE_ARRAY
1927 && TYPE_CODE (type0
) != TYPE_CODE_STRING
)
1928 error (_("First argument of %s must be a string."), fnname
);
1930 const char *a0
= (const char *) value_contents (argv
[0]);
1931 cmd_list_element
*cmd
= lookup_cmd (&a0
, showlist
, "", -1, 0);
1933 if (cmd
== nullptr || cmd_type (cmd
) != show_cmd
)
1934 error (_("First argument of %s must be a "
1935 "valid setting of the 'show' command."), fnname
);
1940 /* Builds a value from the show CMD. */
1942 static struct value
*
1943 value_from_setting (const cmd_list_element
*cmd
, struct gdbarch
*gdbarch
)
1945 switch (cmd
->var_type
)
1948 if (*(int *) cmd
->var
== INT_MAX
)
1949 return value_from_longest (builtin_type (gdbarch
)->builtin_int
,
1952 return value_from_longest (builtin_type (gdbarch
)->builtin_int
,
1955 return value_from_longest (builtin_type (gdbarch
)->builtin_int
,
1958 return value_from_longest (builtin_type (gdbarch
)->builtin_int
,
1959 *(bool *) cmd
->var
? 1 : 0);
1960 case var_zuinteger_unlimited
:
1961 return value_from_longest (builtin_type (gdbarch
)->builtin_int
,
1963 case var_auto_boolean
:
1967 switch (*(enum auto_boolean
*) cmd
->var
)
1969 case AUTO_BOOLEAN_TRUE
:
1972 case AUTO_BOOLEAN_FALSE
:
1975 case AUTO_BOOLEAN_AUTO
:
1979 gdb_assert_not_reached ("invalid var_auto_boolean");
1981 return value_from_longest (builtin_type (gdbarch
)->builtin_int
,
1985 if (*(unsigned int *) cmd
->var
== UINT_MAX
)
1986 return value_from_ulongest
1987 (builtin_type (gdbarch
)->builtin_unsigned_int
, 0);
1989 return value_from_ulongest
1990 (builtin_type (gdbarch
)->builtin_unsigned_int
,
1991 *(unsigned int *) cmd
->var
);
1993 return value_from_ulongest (builtin_type (gdbarch
)->builtin_unsigned_int
,
1994 *(unsigned int *) cmd
->var
);
1996 case var_string_noescape
:
1997 case var_optional_filename
:
2000 if (*(char **) cmd
->var
)
2001 return value_cstring (*(char **) cmd
->var
, strlen (*(char **) cmd
->var
),
2002 builtin_type (gdbarch
)->builtin_char
);
2004 return value_cstring ("", 1,
2005 builtin_type (gdbarch
)->builtin_char
);
2007 gdb_assert_not_reached ("bad var_type");
2011 /* Implementation of the convenience function $_gdb_setting. */
2013 static struct value
*
2014 gdb_setting_internal_fn (struct gdbarch
*gdbarch
,
2015 const struct language_defn
*language
,
2016 void *cookie
, int argc
, struct value
**argv
)
2018 return value_from_setting (setting_cmd ("$_gdb_setting", showlist
,
2023 /* Implementation of the convenience function $_gdb_maint_setting. */
2025 static struct value
*
2026 gdb_maint_setting_internal_fn (struct gdbarch
*gdbarch
,
2027 const struct language_defn
*language
,
2028 void *cookie
, int argc
, struct value
**argv
)
2030 return value_from_setting (setting_cmd ("$_gdb_maint_setting",
2031 maintenance_show_cmdlist
,
2036 /* Builds a string value from the show CMD. */
2038 static struct value
*
2039 str_value_from_setting (const cmd_list_element
*cmd
, struct gdbarch
*gdbarch
)
2041 switch (cmd
->var_type
)
2046 case var_zuinteger_unlimited
:
2047 case var_auto_boolean
:
2051 std::string cmd_val
= get_setshow_command_value_string (cmd
);
2053 return value_cstring (cmd_val
.c_str (), cmd_val
.size (),
2054 builtin_type (gdbarch
)->builtin_char
);
2058 case var_string_noescape
:
2059 case var_optional_filename
:
2062 /* For these cases, we do not use get_setshow_command_value_string,
2063 as this function handle some characters specially, e.g. by
2064 escaping quotes. So, we directly use the cmd->var string value,
2065 similarly to the value_from_setting code for these cases. */
2066 if (*(char **) cmd
->var
)
2067 return value_cstring (*(char **) cmd
->var
, strlen (*(char **) cmd
->var
),
2068 builtin_type (gdbarch
)->builtin_char
);
2070 return value_cstring ("", 1,
2071 builtin_type (gdbarch
)->builtin_char
);
2074 gdb_assert_not_reached ("bad var_type");
2078 /* Implementation of the convenience function $_gdb_setting_str. */
2080 static struct value
*
2081 gdb_setting_str_internal_fn (struct gdbarch
*gdbarch
,
2082 const struct language_defn
*language
,
2083 void *cookie
, int argc
, struct value
**argv
)
2085 return str_value_from_setting (setting_cmd ("$_gdb_setting_str",
2086 showlist
, argc
, argv
),
2091 /* Implementation of the convenience function $_gdb_maint_setting_str. */
2093 static struct value
*
2094 gdb_maint_setting_str_internal_fn (struct gdbarch
*gdbarch
,
2095 const struct language_defn
*language
,
2096 void *cookie
, int argc
, struct value
**argv
)
2098 return str_value_from_setting (setting_cmd ("$_gdb_maint_setting_str",
2099 maintenance_show_cmdlist
,
2105 _initialize_cli_cmds (void)
2107 struct cmd_list_element
*c
;
2109 /* Define the classes of commands.
2110 They will appear in the help list in alphabetical order. */
2112 add_cmd ("internals", class_maintenance
, _("\
2113 Maintenance commands.\n\
2114 Some gdb commands are provided just for use by gdb maintainers.\n\
2115 These commands are subject to frequent change, and may not be as\n\
2116 well documented as user commands."),
2118 add_cmd ("obscure", class_obscure
, _("Obscure features."), &cmdlist
);
2119 add_cmd ("aliases", class_alias
,
2120 _("Aliases of other commands."), &cmdlist
);
2121 add_cmd ("user-defined", class_user
, _("\
2122 User-defined commands.\n\
2123 The commands in this class are those defined by the user.\n\
2124 Use the \"define\" command to define a command."), &cmdlist
);
2125 add_cmd ("support", class_support
, _("Support facilities."), &cmdlist
);
2127 add_cmd ("status", class_info
, _("Status inquiries."), &cmdlist
);
2128 add_cmd ("files", class_files
, _("Specifying and examining files."),
2130 add_cmd ("breakpoints", class_breakpoint
,
2131 _("Making program stop at certain points."), &cmdlist
);
2132 add_cmd ("data", class_vars
, _("Examining data."), &cmdlist
);
2133 add_cmd ("stack", class_stack
, _("\
2134 Examining the stack.\n\
2135 The stack is made up of stack frames. Gdb assigns numbers to stack frames\n\
2136 counting from zero for the innermost (currently executing) frame.\n\n\
2137 At any time gdb identifies one frame as the \"selected\" frame.\n\
2138 Variable lookups are done with respect to the selected frame.\n\
2139 When the program being debugged stops, gdb selects the innermost frame.\n\
2140 The commands below can be used to select other frames by number or address."),
2142 add_cmd ("running", class_run
, _("Running the program."), &cmdlist
);
2144 /* Define general commands. */
2146 add_com ("pwd", class_files
, pwd_command
, _("\
2147 Print working directory.\n\
2148 This is used for your program as well."));
2150 c
= add_cmd ("cd", class_files
, cd_command
, _("\
2151 Set working directory to DIR for debugger.\n\
2152 The debugger's current working directory specifies where scripts and other\n\
2153 files that can be loaded by GDB are located.\n\
2154 In order to change the inferior's current working directory, the recommended\n\
2155 way is to use the \"set cwd\" command."), &cmdlist
);
2156 set_cmd_completer (c
, filename_completer
);
2158 add_com ("echo", class_support
, echo_command
, _("\
2159 Print a constant string. Give string as argument.\n\
2160 C escape sequences may be used in the argument.\n\
2161 No newline is added at the end of the argument;\n\
2162 use \"\\n\" if you want a newline to be printed.\n\
2163 Since leading and trailing whitespace are ignored in command arguments,\n\
2164 if you want to print some you must use \"\\\" before leading whitespace\n\
2165 to be printed or after trailing whitespace."));
2167 add_setshow_enum_cmd ("script-extension", class_support
,
2168 script_ext_enums
, &script_ext_mode
, _("\
2169 Set mode for script filename extension recognition."), _("\
2170 Show mode for script filename extension recognition."), _("\
2171 off == no filename extension recognition (all sourced files are GDB scripts)\n\
2172 soft == evaluate script according to filename extension, fallback to GDB script"
2174 strict == evaluate script according to filename extension, error if not supported"
2177 show_script_ext_mode
,
2178 &setlist
, &showlist
);
2180 add_com ("quit", class_support
, quit_command
, _("\
2182 Usage: quit [EXPR]\n\
2183 The optional expression EXPR, if present, is evaluated and the result\n\
2184 used as GDB's exit code. The default is zero."));
2185 c
= add_com ("help", class_support
, help_command
,
2186 _("Print list of commands."));
2187 set_cmd_completer (c
, command_completer
);
2188 add_com_alias ("q", "quit", class_support
, 1);
2189 add_com_alias ("h", "help", class_support
, 1);
2191 add_setshow_boolean_cmd ("verbose", class_support
, &info_verbose
, _("\
2192 Set verbosity."), _("\
2193 Show verbosity."), NULL
,
2196 &setlist
, &showlist
);
2198 add_prefix_cmd ("history", class_support
, set_history
,
2199 _("Generic command for setting command history parameters."),
2200 &sethistlist
, "set history ", 0, &setlist
);
2201 add_prefix_cmd ("history", class_support
, show_history
,
2202 _("Generic command for showing command history parameters."),
2203 &showhistlist
, "show history ", 0, &showlist
);
2205 add_setshow_boolean_cmd ("expansion", no_class
, &history_expansion_p
, _("\
2206 Set history expansion on command input."), _("\
2207 Show history expansion on command input."), _("\
2208 Without an argument, history expansion is enabled."),
2210 show_history_expansion_p
,
2211 &sethistlist
, &showhistlist
);
2213 add_prefix_cmd ("info", class_info
, info_command
, _("\
2214 Generic command for showing things about the program being debugged."),
2215 &infolist
, "info ", 0, &cmdlist
);
2216 add_com_alias ("i", "info", class_info
, 1);
2217 add_com_alias ("inf", "info", class_info
, 1);
2219 add_com ("complete", class_obscure
, complete_command
,
2220 _("List the completions for the rest of the line as a command."));
2222 add_prefix_cmd ("show", class_info
, show_command
, _("\
2223 Generic command for showing things about the debugger."),
2224 &showlist
, "show ", 0, &cmdlist
);
2225 /* Another way to get at the same thing. */
2226 add_info ("set", show_command
, _("Show all GDB settings."));
2228 c
= add_com ("with", class_vars
, with_command
, _("\
2229 Temporarily set SETTING to VALUE, run COMMAND, and restore SETTING.\n\
2230 Usage: with SETTING [VALUE] [-- COMMAND]\n\
2231 Usage: w SETTING [VALUE] [-- COMMAND]\n\
2232 With no COMMAND, repeats the last executed command.\n\
2234 SETTING is any setting you can change with the \"set\" subcommands.\n\
2236 with language pascal -- print obj\n\
2237 with print elements unlimited -- print obj\n\
2239 You can change multiple settings using nested with, and use\n\
2240 abbreviations for commands and/or values. E.g.:\n\
2241 w la p -- w p el u -- p obj"));
2242 set_cmd_completer_handle_brkchars (c
, with_command_completer
);
2243 add_com_alias ("w", "with", class_vars
, 1);
2245 add_internal_function ("_gdb_setting_str", _("\
2246 $_gdb_setting_str - returns the value of a GDB setting as a string.\n\
2247 Usage: $_gdb_setting_str (setting)\n\
2249 auto-boolean values are \"off\", \"on\", \"auto\".\n\
2250 boolean values are \"off\", \"on\".\n\
2251 Some integer settings accept an unlimited value, returned\n\
2252 as \"unlimited\"."),
2253 gdb_setting_str_internal_fn
, NULL
);
2255 add_internal_function ("_gdb_setting", _("\
2256 $_gdb_setting - returns the value of a GDB setting.\n\
2257 Usage: $_gdb_setting (setting)\n\
2258 auto-boolean values are \"off\", \"on\", \"auto\".\n\
2259 boolean values are \"off\", \"on\".\n\
2260 Some integer settings accept an unlimited value, returned\n\
2261 as 0 or -1 depending on the setting."),
2262 gdb_setting_internal_fn
, NULL
);
2264 add_internal_function ("_gdb_maint_setting_str", _("\
2265 $_gdb_maint_setting_str - returns the value of a GDB maintenance setting as a string.\n\
2266 Usage: $_gdb_maint_setting_str (setting)\n\
2268 auto-boolean values are \"off\", \"on\", \"auto\".\n\
2269 boolean values are \"off\", \"on\".\n\
2270 Some integer settings accept an unlimited value, returned\n\
2271 as \"unlimited\"."),
2272 gdb_maint_setting_str_internal_fn
, NULL
);
2274 add_internal_function ("_gdb_maint_setting", _("\
2275 $_gdb_maint_setting - returns the value of a GDB maintenance setting.\n\
2276 Usage: $_gdb_maint_setting (setting)\n\
2277 auto-boolean values are \"off\", \"on\", \"auto\".\n\
2278 boolean values are \"off\", \"on\".\n\
2279 Some integer settings accept an unlimited value, returned\n\
2280 as 0 or -1 depending on the setting."),
2281 gdb_maint_setting_internal_fn
, NULL
);
2283 add_cmd ("commands", no_set_class
, show_commands
, _("\
2284 Show the history of commands you typed.\n\
2285 You can supply a command number to start with, or a `+' to start after\n\
2286 the previous command number shown."),
2289 add_cmd ("version", no_set_class
, show_version
,
2290 _("Show what version of GDB this is."), &showlist
);
2292 add_cmd ("configuration", no_set_class
, show_configuration
,
2293 _("Show how GDB was configured at build time."), &showlist
);
2295 add_setshow_zinteger_cmd ("remote", no_class
, &remote_debug
, _("\
2296 Set debugging of remote protocol."), _("\
2297 Show debugging of remote protocol."), _("\
2298 When enabled, each packet sent or received with the remote target\n\
2302 &setdebuglist
, &showdebuglist
);
2304 add_setshow_zuinteger_unlimited_cmd ("remotetimeout", no_class
,
2305 &remote_timeout
, _("\
2306 Set timeout limit to wait for target to respond."), _("\
2307 Show timeout limit to wait for target to respond."), _("\
2308 This value is used to set the time limit for gdb to wait for a response\n\
2311 show_remote_timeout
,
2312 &setlist
, &showlist
);
2314 add_prefix_cmd ("debug", no_class
, set_debug
,
2315 _("Generic command for setting gdb debugging flags."),
2316 &setdebuglist
, "set debug ", 0, &setlist
);
2318 add_prefix_cmd ("debug", no_class
, show_debug
,
2319 _("Generic command for showing gdb debugging flags."),
2320 &showdebuglist
, "show debug ", 0, &showlist
);
2322 c
= add_com ("shell", class_support
, shell_command
, _("\
2323 Execute the rest of the line as a shell command.\n\
2324 With no arguments, run an inferior shell."));
2325 set_cmd_completer (c
, filename_completer
);
2327 add_com_alias ("!", "shell", class_support
, 0);
2329 c
= add_com ("edit", class_files
, edit_command
, _("\
2330 Edit specified file or function.\n\
2331 With no argument, edits file containing most recent line listed.\n\
2332 Editing targets can be specified in these ways:\n\
2333 FILE:LINENUM, to edit at that line in that file,\n\
2334 FUNCTION, to edit at the beginning of that function,\n\
2335 FILE:FUNCTION, to distinguish among like-named static functions.\n\
2336 *ADDRESS, to edit at the line containing that address.\n\
2337 Uses EDITOR environment variable contents as editor (or ex as default)."));
2339 c
->completer
= location_completer
;
2341 c
= add_com ("pipe", class_support
, pipe_command
, _("\
2342 Send the output of a gdb command to a shell command.\n\
2343 Usage: | [COMMAND] | SHELL_COMMAND\n\
2344 Usage: | -d DELIM COMMAND DELIM SHELL_COMMAND\n\
2345 Usage: pipe [COMMAND] | SHELL_COMMAND\n\
2346 Usage: pipe -d DELIM COMMAND DELIM SHELL_COMMAND\n\
2348 Executes COMMAND and sends its output to SHELL_COMMAND.\n\
2350 The -d option indicates to use the string DELIM to separate COMMAND\n\
2351 from SHELL_COMMAND, in alternative to |. This is useful in\n\
2352 case COMMAND contains a | character.\n\
2354 With no COMMAND, repeat the last executed command\n\
2355 and send its output to SHELL_COMMAND."));
2356 set_cmd_completer_handle_brkchars (c
, pipe_command_completer
);
2357 add_com_alias ("|", "pipe", class_support
, 0);
2359 add_com ("list", class_files
, list_command
, _("\
2360 List specified function or line.\n\
2361 With no argument, lists ten more lines after or around previous listing.\n\
2362 \"list -\" lists the ten lines before a previous ten-line listing.\n\
2363 One argument specifies a line, and ten lines are listed around that line.\n\
2364 Two arguments with comma between specify starting and ending lines to list.\n\
2365 Lines can be specified in these ways:\n\
2366 LINENUM, to list around that line in current file,\n\
2367 FILE:LINENUM, to list around that line in that file,\n\
2368 FUNCTION, to list around beginning of that function,\n\
2369 FILE:FUNCTION, to distinguish among like-named static functions.\n\
2370 *ADDRESS, to list around the line containing that address.\n\
2371 With two args, if one is empty, it stands for ten lines away from\n\
2374 By default, when a single location is given, display ten lines.\n\
2375 This can be changed using \"set listsize\", and the current value\n\
2376 can be shown using \"show listsize\"."));
2378 add_com_alias ("l", "list", class_files
, 1);
2381 add_com_alias ("file", "list", class_files
, 1);
2383 c
= add_com ("disassemble", class_vars
, disassemble_command
, _("\
2384 Disassemble a specified section of memory.\n\
2385 Default is the function surrounding the pc of the selected frame.\n\
2387 With a /m modifier, source lines are included (if available).\n\
2388 This view is \"source centric\": the output is in source line order,\n\
2389 regardless of any optimization that is present. Only the main source file\n\
2390 is displayed, not those of, e.g., any inlined functions.\n\
2391 This modifier hasn't proved useful in practice and is deprecated\n\
2394 With a /s modifier, source lines are included (if available).\n\
2395 This differs from /m in two important respects:\n\
2396 - the output is still in pc address order, and\n\
2397 - file names and contents for all relevant source files are displayed.\n\
2399 With a /r modifier, raw instructions in hex are included.\n\
2401 With a single argument, the function surrounding that address is dumped.\n\
2402 Two arguments (separated by a comma) are taken as a range of memory to dump,\n\
2403 in the form of \"start,end\", or \"start,+length\".\n\
2405 Note that the address is interpreted as an expression, not as a location\n\
2406 like in the \"break\" command.\n\
2407 So, for example, if you want to disassemble function bar in file foo.c\n\
2408 you must type \"disassemble 'foo.c'::bar\" and not \"disassemble foo.c:bar\"."));
2409 set_cmd_completer (c
, location_completer
);
2411 c
= add_com ("make", class_support
, make_command
, _("\
2412 Run the ``make'' program using the rest of the line as arguments."));
2413 set_cmd_completer (c
, filename_completer
);
2414 add_cmd ("user", no_class
, show_user
, _("\
2415 Show definitions of non-python/scheme user defined commands.\n\
2416 Argument is the name of the user defined command.\n\
2417 With no argument, show definitions of all user defined commands."), &showlist
);
2418 add_com ("apropos", class_support
, apropos_command
, _("\
2419 Search for commands matching a REGEXP.\n\
2420 Usage: apropos [-v] REGEXP\n\
2421 Flag -v indicates to produce a verbose output, showing full documentation\n\
2422 of the matching commands."));
2424 add_setshow_uinteger_cmd ("max-user-call-depth", no_class
,
2425 &max_user_call_depth
, _("\
2426 Set the max call depth for non-python/scheme user-defined commands."), _("\
2427 Show the max call depth for non-python/scheme user-defined commands."), NULL
,
2429 show_max_user_call_depth
,
2430 &setlist
, &showlist
);
2432 add_setshow_boolean_cmd ("trace-commands", no_class
, &trace_commands
, _("\
2433 Set tracing of GDB CLI commands."), _("\
2434 Show state of GDB CLI command tracing."), _("\
2435 When 'on', each command is displayed as it is executed."),
2438 &setlist
, &showlist
);
2440 c
= add_com ("alias", class_support
, alias_command
, _("\
2441 Define a new command that is an alias of an existing command.\n\
2442 Usage: alias [-a] [--] ALIAS = COMMAND\n\
2443 ALIAS is the name of the alias command to create.\n\
2444 COMMAND is the command being aliased to.\n\
2445 If \"-a\" is specified, the command is an abbreviation,\n\
2446 and will not appear in help command list output.\n\
2449 Make \"spe\" an alias of \"set print elements\":\n\
2450 alias spe = set print elements\n\
2451 Make \"elms\" an alias of \"elements\" in the \"set print\" command:\n\
2452 alias -a set print elms = set print elements"));
2454 const char *source_help_text
= xstrprintf (_("\
2455 Read commands from a file named FILE.\n\
2457 Usage: source [-s] [-v] FILE\n\
2458 -s: search for the script in the source search path,\n\
2459 even if FILE contains directories.\n\
2460 -v: each command in FILE is echoed as it is executed.\n\
2462 Note that the file \"%s\" is read automatically in this way\n\
2463 when GDB is started."), GDBINIT
);
2464 c
= add_cmd ("source", class_support
, source_command
,
2465 source_help_text
, &cmdlist
);
2466 set_cmd_completer (c
, filename_completer
);