1 /* GDB CLI commands.
2 
3    Copyright (C) 2000-2021 Free Software Foundation, Inc.
4 
5    This file is part of GDB.
6 
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.
11 
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.
16 
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/>.  */
19 
20 #include "defs.h"
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.  */
26 #include "gdbcmd.h"
27 #include "gdb_regex.h"	/* Used by apropos_command.  */
28 #include "gdb_vfork.h"
29 #include "linespec.h"
30 #include "expression.h"
31 #include "frame.h"
32 #include "value.h"
33 #include "language.h"
34 #include "filenames.h"	/* For DOSish file names.  */
35 #include "objfiles.h"
36 #include "source.h"
37 #include "disasm.h"
38 #include "tracepoint.h"
39 #include "gdbsupport/filestuff.h"
40 #include "location.h"
41 #include "block.h"
42 
43 #include "ui-out.h"
44 #include "interps.h"
45 
46 #include "top.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"
53 #include "cli/cli-style.h"
54 
55 #include "extension.h"
56 #include "gdbsupport/pathstuff.h"
57 #include "gdbsupport/gdb_tilde_expand.h"
58 
59 #ifdef TUI
60 #include "tui/tui.h"	/* For tui_active et.al.  */
61 #endif
62 
63 #include <fcntl.h>
64 #include <algorithm>
65 #include <string>
66 
67 /* Prototypes for local utility functions */
68 
69 static void print_sal_location (const symtab_and_line &sal);
70 
71 static void ambiguous_line_spec (gdb::array_view<const symtab_and_line> sals,
72 				 const char *format, ...)
73   ATTRIBUTE_PRINTF (2, 3);
74 
75 static void filter_sals (std::vector<symtab_and_line> &);
76 
77 
78 /* See cli-cmds.h. */
79 unsigned int max_user_call_depth;
80 
81 /* Define all cmd_list_elements.  */
82 
83 /* Chain containing all defined commands.  */
84 
85 struct cmd_list_element *cmdlist;
86 
87 /* Chain containing all defined info subcommands.  */
88 
89 struct cmd_list_element *infolist;
90 
91 /* Chain containing all defined enable subcommands.  */
92 
93 struct cmd_list_element *enablelist;
94 
95 /* Chain containing all defined disable subcommands.  */
96 
97 struct cmd_list_element *disablelist;
98 
99 /* Chain containing all defined stop subcommands.  */
100 
101 struct cmd_list_element *stoplist;
102 
103 /* Chain containing all defined delete subcommands.  */
104 
105 struct cmd_list_element *deletelist;
106 
107 /* Chain containing all defined detach subcommands.  */
108 
109 struct cmd_list_element *detachlist;
110 
111 /* Chain containing all defined kill subcommands.  */
112 
113 struct cmd_list_element *killlist;
114 
115 /* Chain containing all defined set subcommands */
116 
117 struct cmd_list_element *setlist;
118 
119 /* Chain containing all defined unset subcommands */
120 
121 struct cmd_list_element *unsetlist;
122 
123 /* Chain containing all defined show subcommands.  */
124 
125 struct cmd_list_element *showlist;
126 
127 /* Chain containing all defined \"set history\".  */
128 
129 struct cmd_list_element *sethistlist;
130 
131 /* Chain containing all defined \"show history\".  */
132 
133 struct cmd_list_element *showhistlist;
134 
135 /* Chain containing all defined \"unset history\".  */
136 
137 struct cmd_list_element *unsethistlist;
138 
139 /* Chain containing all defined maintenance subcommands.  */
140 
141 struct cmd_list_element *maintenancelist;
142 
143 /* Chain containing all defined "maintenance info" subcommands.  */
144 
145 struct cmd_list_element *maintenanceinfolist;
146 
147 /* Chain containing all defined "maintenance print" subcommands.  */
148 
149 struct cmd_list_element *maintenanceprintlist;
150 
151 /* Chain containing all defined "maintenance check" subcommands.  */
152 
153 struct cmd_list_element *maintenancechecklist;
154 
155 /* Chain containing all defined "maintenance flush" subcommands.  */
156 
157 struct cmd_list_element *maintenanceflushlist;
158 
159 struct cmd_list_element *setprintlist;
160 
161 struct cmd_list_element *showprintlist;
162 
163 struct cmd_list_element *setdebuglist;
164 
165 struct cmd_list_element *showdebuglist;
166 
167 struct cmd_list_element *setchecklist;
168 
169 struct cmd_list_element *showchecklist;
170 
171 /* Command tracing state.  */
172 
173 int source_verbose = 0;
174 bool trace_commands = false;
175 
176 /* 'script-extension' option support.  */
177 
178 static const char script_ext_off[] = "off";
179 static const char script_ext_soft[] = "soft";
180 static const char script_ext_strict[] = "strict";
181 
182 static const char *const script_ext_enums[] = {
183   script_ext_off,
184   script_ext_soft,
185   script_ext_strict,
186   NULL
187 };
188 
189 static const char *script_ext_mode = script_ext_soft;
190 
191 /* Utility used everywhere when at least one argument is needed and
192    none is supplied.  */
193 
194 void
error_no_arg(const char * why)195 error_no_arg (const char *why)
196 {
197   error (_("Argument required (%s)."), why);
198 }
199 
200 /* This implements the "info" prefix command.  Normally such commands
201    are automatically handled by add_basic_prefix_cmd, but in this case
202    a separate command is used so that it can be hooked into by
203    gdb-gdb.gdb.  */
204 
205 static void
info_command(const char * arg,int from_tty)206 info_command (const char *arg, int from_tty)
207 {
208   help_list (infolist, "info ", all_commands, gdb_stdout);
209 }
210 
211 /* See cli/cli-cmds.h.  */
212 
213 void
with_command_1(const char * set_cmd_prefix,cmd_list_element * setlist,const char * args,int from_tty)214 with_command_1 (const char *set_cmd_prefix,
215 		cmd_list_element *setlist, const char *args, int from_tty)
216 {
217   if (args == nullptr)
218     error (_("Missing arguments."));
219 
220   const char *delim = strstr (args, "--");
221   const char *nested_cmd = nullptr;
222 
223   if (delim == args)
224     error (_("Missing setting before '--' delimiter"));
225 
226   if (delim == nullptr || *skip_spaces (&delim[2]) == '\0')
227     nested_cmd = repeat_previous ();
228 
229   cmd_list_element *set_cmd = lookup_cmd (&args, setlist, set_cmd_prefix,
230 					  nullptr,
231 					  /*allow_unknown=*/ 0,
232 					  /*ignore_help_classes=*/ 1);
233   gdb_assert (set_cmd != nullptr);
234 
235   if (set_cmd->var == nullptr)
236     error (_("Cannot use this setting with the \"with\" command"));
237 
238   std::string temp_value
239     = (delim == nullptr ? args : std::string (args, delim - args));
240 
241   if (nested_cmd == nullptr)
242     nested_cmd = skip_spaces (delim + 2);
243 
244   std::string org_value = get_setshow_command_value_string (set_cmd);
245 
246   /* Tweak the setting to the new temporary value.  */
247   do_set_command (temp_value.c_str (), from_tty, set_cmd);
248 
249   try
250     {
251       scoped_restore save_async = make_scoped_restore (&current_ui->async, 0);
252 
253       /* Execute the nested command.  */
254       execute_command (nested_cmd, from_tty);
255     }
256   catch (const gdb_exception &ex)
257     {
258       /* Restore the setting and rethrow.  If restoring the setting
259 	 throws, swallow the new exception and warn.  There's nothing
260 	 else we can reasonably do.  */
261       try
262 	{
263 	  do_set_command (org_value.c_str (), from_tty, set_cmd);
264 	}
265       catch (const gdb_exception &ex2)
266 	{
267 	  warning (_("Couldn't restore setting: %s"), ex2.what ());
268 	}
269 
270       throw;
271     }
272 
273   /* Restore the setting.  */
274   do_set_command (org_value.c_str (), from_tty, set_cmd);
275 }
276 
277 /* See cli/cli-cmds.h.  */
278 
279 void
with_command_completer_1(const char * set_cmd_prefix,completion_tracker & tracker,const char * text)280 with_command_completer_1 (const char *set_cmd_prefix,
281 			  completion_tracker &tracker,
282 			  const char *text)
283 {
284   tracker.set_use_custom_word_point (true);
285 
286   const char *delim = strstr (text, "--");
287 
288   /* If we're still not past the "--" delimiter, complete the "with"
289      command as if it was a "set" command.  */
290   if (delim == text
291       || delim == nullptr
292       || !isspace (delim[-1])
293       || !(isspace (delim[2]) || delim[2] == '\0'))
294     {
295       std::string new_text = std::string (set_cmd_prefix) + text;
296       tracker.advance_custom_word_point_by (-(int) strlen (set_cmd_prefix));
297       complete_nested_command_line (tracker, new_text.c_str ());
298       return;
299     }
300 
301   /* We're past the "--" delimiter.  Complete on the sub command.  */
302   const char *nested_cmd = skip_spaces (delim + 2);
303   tracker.advance_custom_word_point_by (nested_cmd - text);
304   complete_nested_command_line (tracker, nested_cmd);
305 }
306 
307 /* The "with" command.  */
308 
309 static void
with_command(const char * args,int from_tty)310 with_command (const char *args, int from_tty)
311 {
312   with_command_1 ("set ", setlist, args, from_tty);
313 }
314 
315 /* "with" command completer.  */
316 
317 static void
with_command_completer(struct cmd_list_element * ignore,completion_tracker & tracker,const char * text,const char *)318 with_command_completer (struct cmd_list_element *ignore,
319 			completion_tracker &tracker,
320 			const char *text, const char * /*word*/)
321 {
322   with_command_completer_1 ("set ", tracker,  text);
323 }
324 
325 /* Look up the contents of TEXT as a command usable with default args.
326    Throws an error if no such command is found.
327    Return the found command and advances TEXT past the found command.
328    If the found command is a postfix command, set *PREFIX_CMD to its
329    prefix command.  */
330 
331 static struct cmd_list_element *
lookup_cmd_for_default_args(const char ** text,struct cmd_list_element ** prefix_cmd)332 lookup_cmd_for_default_args (const char **text,
333 			     struct cmd_list_element **prefix_cmd)
334 {
335   const char *orig_text = *text;
336   struct cmd_list_element *lcmd;
337 
338   if (*text == nullptr || skip_spaces (*text) == nullptr)
339     error (_("ALIAS missing."));
340 
341   /* We first use lookup_cmd to verify TEXT unambiguously identifies
342      a command.  */
343   lcmd = lookup_cmd (text, cmdlist, "", NULL,
344 		     /*allow_unknown=*/ 0,
345 		     /*ignore_help_classes=*/ 1);
346 
347   /* Note that we accept default args for prefix commands,
348      as a prefix command can also be a valid usable
349      command accepting some arguments.
350      For example, "thread apply" applies a command to a
351      list of thread ids, and is also the prefix command for
352      thread apply all.  */
353 
354   /* We have an unambiguous command for which default args
355      can be specified.  What remains after having found LCMD
356      is either spaces, or the default args character.  */
357 
358   /* We then use lookup_cmd_composition to detect if the user
359      has specified an alias, and find the possible prefix_cmd
360      of cmd.  */
361   struct cmd_list_element *alias, *cmd;
362   lookup_cmd_composition
363     (std::string (orig_text, *text - orig_text).c_str (),
364      &alias, prefix_cmd, &cmd);
365   gdb_assert (cmd != nullptr);
366   gdb_assert (cmd == lcmd);
367   if (alias != nullptr)
368     cmd = alias;
369 
370   return cmd;
371 }
372 
373 /* Provide documentation on command or list given by COMMAND.  FROM_TTY
374    is ignored.  */
375 
376 static void
help_command(const char * command,int from_tty)377 help_command (const char *command, int from_tty)
378 {
379   help_cmd (command, gdb_stdout);
380 }
381 
382 
383 /* Note: The "complete" command is used by Emacs to implement completion.
384    [Is that why this function writes output with *_unfiltered?]  */
385 
386 static void
complete_command(const char * arg,int from_tty)387 complete_command (const char *arg, int from_tty)
388 {
389   dont_repeat ();
390 
391   if (max_completions == 0)
392     {
393       /* Only print this for non-mi frontends.  An MI frontend may not
394 	 be able to handle this.  */
395       if (!current_uiout->is_mi_like_p ())
396 	{
397 	  printf_unfiltered (_("max-completions is zero,"
398 			       " completion is disabled.\n"));
399 	}
400       return;
401     }
402 
403   if (arg == NULL)
404     arg = "";
405 
406   int quote_char = '\0';
407   const char *word;
408 
409   completion_result result = complete (arg, &word, &quote_char);
410 
411   if (result.number_matches != 0)
412     {
413       std::string arg_prefix (arg, word - arg);
414 
415       if (result.number_matches == 1)
416 	printf_unfiltered ("%s%s\n", arg_prefix.c_str (), result.match_list[0]);
417       else
418 	{
419 	  result.sort_match_list ();
420 
421 	  for (size_t i = 0; i < result.number_matches; i++)
422 	    {
423 	      printf_unfiltered ("%s%s",
424 				 arg_prefix.c_str (),
425 				 result.match_list[i + 1]);
426 	      if (quote_char)
427 		printf_unfiltered ("%c", quote_char);
428 	      printf_unfiltered ("\n");
429 	    }
430 	}
431 
432       if (result.number_matches == max_completions)
433 	{
434 	  /* ARG_PREFIX and WORD are included in the output so that emacs
435 	     will include the message in the output.  */
436 	  printf_unfiltered (_("%s%s %s\n"),
437 			     arg_prefix.c_str (), word,
438 			     get_max_completions_reached_message ());
439 	}
440     }
441 }
442 
443 int
is_complete_command(struct cmd_list_element * c)444 is_complete_command (struct cmd_list_element *c)
445 {
446   return cmd_cfunc_eq (c, complete_command);
447 }
448 
449 static void
show_version(const char * args,int from_tty)450 show_version (const char *args, int from_tty)
451 {
452   print_gdb_version (gdb_stdout, true);
453   printf_filtered ("\n");
454 }
455 
456 static void
show_configuration(const char * args,int from_tty)457 show_configuration (const char *args, int from_tty)
458 {
459   print_gdb_configuration (gdb_stdout);
460 }
461 
462 /* Handle the quit command.  */
463 
464 void
quit_command(const char * args,int from_tty)465 quit_command (const char *args, int from_tty)
466 {
467   int exit_code = 0;
468 
469   /* An optional expression may be used to cause gdb to terminate with
470      the value of that expression.  */
471   if (args)
472     {
473       struct value *val = parse_and_eval (args);
474 
475       exit_code = (int) value_as_long (val);
476     }
477 
478   if (!quit_confirm ())
479     error (_("Not confirmed."));
480 
481   query_if_trace_running (from_tty);
482 
483   quit_force (args ? &exit_code : NULL, from_tty);
484 }
485 
486 static void
pwd_command(const char * args,int from_tty)487 pwd_command (const char *args, int from_tty)
488 {
489   if (args)
490     error (_("The \"pwd\" command does not take an argument: %s"), args);
491 
492   gdb::unique_xmalloc_ptr<char> cwd (getcwd (NULL, 0));
493 
494   if (cwd == NULL)
495     error (_("Error finding name of working directory: %s"),
496 	   safe_strerror (errno));
497 
498   if (strcmp (cwd.get (), current_directory) != 0)
499     printf_unfiltered (_("Working directory %ps\n (canonically %ps).\n"),
500 		       styled_string (file_name_style.style (),
501 				      current_directory),
502 		       styled_string (file_name_style.style (), cwd.get ()));
503   else
504     printf_unfiltered (_("Working directory %ps.\n"),
505 		       styled_string (file_name_style.style (),
506 				      current_directory));
507 }
508 
509 void
cd_command(const char * dir,int from_tty)510 cd_command (const char *dir, int from_tty)
511 {
512   int len;
513   /* Found something other than leading repetitions of "/..".  */
514   int found_real_path;
515   char *p;
516 
517   /* If the new directory is absolute, repeat is a no-op; if relative,
518      repeat might be useful but is more likely to be a mistake.  */
519   dont_repeat ();
520 
521   gdb::unique_xmalloc_ptr<char> dir_holder
522     (tilde_expand (dir != NULL ? dir : "~"));
523   dir = dir_holder.get ();
524 
525   if (chdir (dir) < 0)
526     perror_with_name (dir);
527 
528 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
529   /* There's too much mess with DOSish names like "d:", "d:.",
530      "d:./foo" etc.  Instead of having lots of special #ifdef'ed code,
531      simply get the canonicalized name of the current directory.  */
532   gdb::unique_xmalloc_ptr<char> cwd (getcwd (NULL, 0));
533   dir = cwd.get ();
534 #endif
535 
536   len = strlen (dir);
537   if (IS_DIR_SEPARATOR (dir[len - 1]))
538     {
539       /* Remove the trailing slash unless this is a root directory
540 	 (including a drive letter on non-Unix systems).  */
541       if (!(len == 1)		/* "/" */
542 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
543 	  && !(len == 3 && dir[1] == ':') /* "d:/" */
544 #endif
545 	  )
546 	len--;
547     }
548 
549   dir_holder.reset (savestring (dir, len));
550   if (IS_ABSOLUTE_PATH (dir_holder.get ()))
551     {
552       xfree (current_directory);
553       current_directory = dir_holder.release ();
554     }
555   else
556     {
557       if (IS_DIR_SEPARATOR (current_directory[strlen (current_directory) - 1]))
558 	current_directory = concat (current_directory, dir_holder.get (),
559 				    (char *) NULL);
560       else
561 	current_directory = concat (current_directory, SLASH_STRING,
562 				    dir_holder.get (), (char *) NULL);
563     }
564 
565   /* Now simplify any occurrences of `.' and `..' in the pathname.  */
566 
567   found_real_path = 0;
568   for (p = current_directory; *p;)
569     {
570       if (IS_DIR_SEPARATOR (p[0]) && p[1] == '.'
571 	  && (p[2] == 0 || IS_DIR_SEPARATOR (p[2])))
572 	memmove (p, p + 2, strlen (p + 2) + 1);
573       else if (IS_DIR_SEPARATOR (p[0]) && p[1] == '.' && p[2] == '.'
574 	       && (p[3] == 0 || IS_DIR_SEPARATOR (p[3])))
575 	{
576 	  if (found_real_path)
577 	    {
578 	      /* Search backwards for the directory just before the "/.."
579 		 and obliterate it and the "/..".  */
580 	      char *q = p;
581 
582 	      while (q != current_directory && !IS_DIR_SEPARATOR (q[-1]))
583 		--q;
584 
585 	      if (q == current_directory)
586 		/* current_directory is
587 		   a relative pathname ("can't happen"--leave it alone).  */
588 		++p;
589 	      else
590 		{
591 		  memmove (q - 1, p + 3, strlen (p + 3) + 1);
592 		  p = q - 1;
593 		}
594 	    }
595 	  else
596 	    /* We are dealing with leading repetitions of "/..", for
597 	       example "/../..", which is the Mach super-root.  */
598 	    p += 3;
599 	}
600       else
601 	{
602 	  found_real_path = 1;
603 	  ++p;
604 	}
605     }
606 
607   forget_cached_source_info ();
608 
609   if (from_tty)
610     pwd_command ((char *) 0, 1);
611 }
612 
613 /* Show the current value of the 'script-extension' option.  */
614 
615 static void
show_script_ext_mode(struct ui_file * file,int from_tty,struct cmd_list_element * c,const char * value)616 show_script_ext_mode (struct ui_file *file, int from_tty,
617 		     struct cmd_list_element *c, const char *value)
618 {
619   fprintf_filtered (file,
620 		    _("Script filename extension recognition is \"%s\".\n"),
621 		    value);
622 }
623 
624 /* Try to open SCRIPT_FILE.
625    If successful, the full path name is stored in *FULL_PATHP,
626    and the stream is returned.
627    If not successful, return NULL; errno is set for the last file
628    we tried to open.
629 
630    If SEARCH_PATH is non-zero, and the file isn't found in cwd,
631    search for it in the source search path.  */
632 
633 gdb::optional<open_script>
find_and_open_script(const char * script_file,int search_path)634 find_and_open_script (const char *script_file, int search_path)
635 {
636   int fd;
637   openp_flags search_flags = OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH;
638   gdb::optional<open_script> opened;
639 
640   gdb::unique_xmalloc_ptr<char> file (tilde_expand (script_file));
641 
642   if (search_path)
643     search_flags |= OPF_SEARCH_IN_PATH;
644 
645   /* Search for and open 'file' on the search path used for source
646      files.  Put the full location in *FULL_PATHP.  */
647   gdb::unique_xmalloc_ptr<char> full_path;
648   fd = openp (source_path, search_flags,
649 	      file.get (), O_RDONLY, &full_path);
650 
651   if (fd == -1)
652     return opened;
653 
654   FILE *result = fdopen (fd, FOPEN_RT);
655   if (result == NULL)
656     {
657       int save_errno = errno;
658 
659       close (fd);
660       errno = save_errno;
661     }
662   else
663     opened.emplace (gdb_file_up (result), std::move (full_path));
664 
665   return opened;
666 }
667 
668 /* Load script FILE, which has already been opened as STREAM.
669    FILE_TO_OPEN is the form of FILE to use if one needs to open the file.
670    This is provided as FILE may have been found via the source search path.
671    An important thing to note here is that FILE may be a symlink to a file
672    with a different or non-existing suffix, and thus one cannot infer the
673    extension language from FILE_TO_OPEN.  */
674 
675 static void
source_script_from_stream(FILE * stream,const char * file,const char * file_to_open)676 source_script_from_stream (FILE *stream, const char *file,
677 			   const char *file_to_open)
678 {
679   if (script_ext_mode != script_ext_off)
680     {
681       const struct extension_language_defn *extlang
682 	= get_ext_lang_of_file (file);
683 
684       if (extlang != NULL)
685 	{
686 	  if (ext_lang_present_p (extlang))
687 	    {
688 	      script_sourcer_func *sourcer
689 		= ext_lang_script_sourcer (extlang);
690 
691 	      gdb_assert (sourcer != NULL);
692 	      sourcer (extlang, stream, file_to_open);
693 	      return;
694 	    }
695 	  else if (script_ext_mode == script_ext_soft)
696 	    {
697 	      /* Assume the file is a gdb script.
698 		 This is handled below.  */
699 	    }
700 	  else
701 	    throw_ext_lang_unsupported (extlang);
702 	}
703     }
704 
705   script_from_file (stream, file);
706 }
707 
708 /* Worker to perform the "source" command.
709    Load script FILE.
710    If SEARCH_PATH is non-zero, and the file isn't found in cwd,
711    search for it in the source search path.  */
712 
713 static void
source_script_with_search(const char * file,int from_tty,int search_path)714 source_script_with_search (const char *file, int from_tty, int search_path)
715 {
716 
717   if (file == NULL || *file == 0)
718     error (_("source command requires file name of file to source."));
719 
720   gdb::optional<open_script> opened = find_and_open_script (file, search_path);
721   if (!opened)
722     {
723       /* The script wasn't found, or was otherwise inaccessible.
724 	 If the source command was invoked interactively, throw an
725 	 error.  Otherwise (e.g. if it was invoked by a script),
726 	 just emit a warning, rather than cause an error.  */
727       if (from_tty)
728 	perror_with_name (file);
729       else
730 	{
731 	  perror_warning_with_name (file);
732 	  return;
733 	}
734     }
735 
736   /* The python support reopens the file, so we need to pass full_path here
737      in case the file was found on the search path.  It's useful to do this
738      anyway so that error messages show the actual file used.  But only do
739      this if we (may have) used search_path, as printing the full path in
740      errors for the non-search case can be more noise than signal.  */
741   const char *file_to_open;
742   gdb::unique_xmalloc_ptr<char> tilde_expanded_file;
743   if (search_path)
744     file_to_open = opened->full_path.get ();
745   else
746     {
747       tilde_expanded_file = gdb_tilde_expand_up (file);
748       file_to_open = tilde_expanded_file.get ();
749     }
750   source_script_from_stream (opened->stream.get (), file, file_to_open);
751 }
752 
753 /* Wrapper around source_script_with_search to export it to main.c
754    for use in loading .gdbinit scripts.  */
755 
756 void
source_script(const char * file,int from_tty)757 source_script (const char *file, int from_tty)
758 {
759   source_script_with_search (file, from_tty, 0);
760 }
761 
762 static void
source_command(const char * args,int from_tty)763 source_command (const char *args, int from_tty)
764 {
765   const char *file = args;
766   int search_path = 0;
767 
768   scoped_restore save_source_verbose = make_scoped_restore (&source_verbose);
769 
770   /* -v causes the source command to run in verbose mode.
771      -s causes the file to be searched in the source search path,
772      even if the file name contains a '/'.
773      We still have to be able to handle filenames with spaces in a
774      backward compatible way, so buildargv is not appropriate.  */
775 
776   if (args)
777     {
778       while (args[0] != '\0')
779 	{
780 	  /* Make sure leading white space does not break the
781 	     comparisons.  */
782 	  args = skip_spaces (args);
783 
784 	  if (args[0] != '-')
785 	    break;
786 
787 	  if (args[1] == 'v' && isspace (args[2]))
788 	    {
789 	      source_verbose = 1;
790 
791 	      /* Skip passed -v.  */
792 	      args = &args[3];
793 	    }
794 	  else if (args[1] == 's' && isspace (args[2]))
795 	    {
796 	      search_path = 1;
797 
798 	      /* Skip passed -s.  */
799 	      args = &args[3];
800 	    }
801 	  else
802 	    break;
803 	}
804 
805       file = skip_spaces (args);
806     }
807 
808   source_script_with_search (file, from_tty, search_path);
809 }
810 
811 
812 static void
echo_command(const char * text,int from_tty)813 echo_command (const char *text, int from_tty)
814 {
815   const char *p = text;
816   int c;
817 
818   if (text)
819     while ((c = *p++) != '\0')
820       {
821 	if (c == '\\')
822 	  {
823 	    /* \ at end of argument is used after spaces
824 	       so they won't be lost.  */
825 	    if (*p == 0)
826 	      return;
827 
828 	    c = parse_escape (get_current_arch (), &p);
829 	    if (c >= 0)
830 	      printf_filtered ("%c", c);
831 	  }
832 	else
833 	  printf_filtered ("%c", c);
834       }
835 
836   reset_terminal_style (gdb_stdout);
837 
838   /* Force this output to appear now.  */
839   wrap_here ("");
840   gdb_flush (gdb_stdout);
841 }
842 
843 /* Sets the last launched shell command convenience variables based on
844    EXIT_STATUS.  */
845 
846 static void
exit_status_set_internal_vars(int exit_status)847 exit_status_set_internal_vars (int exit_status)
848 {
849   struct internalvar *var_code = lookup_internalvar ("_shell_exitcode");
850   struct internalvar *var_signal = lookup_internalvar ("_shell_exitsignal");
851 
852   clear_internalvar (var_code);
853   clear_internalvar (var_signal);
854   if (WIFEXITED (exit_status))
855     set_internalvar_integer (var_code, WEXITSTATUS (exit_status));
856 #ifdef __MINGW32__
857   else if (WIFSIGNALED (exit_status) && WTERMSIG (exit_status) == -1)
858     {
859       /* The -1 condition can happen on MinGW, if we don't recognize
860 	 the fatal exception code encoded in the exit status; see
861 	 gdbsupport/gdb_wait.c.  We don't want to lose information in
862 	 the exit status in that case.  Record it as a normal exit
863 	 with the full exit status, including the higher 0xC0000000
864 	 bits.  */
865       set_internalvar_integer (var_code, exit_status);
866     }
867 #endif
868   else if (WIFSIGNALED (exit_status))
869     set_internalvar_integer (var_signal, WTERMSIG (exit_status));
870   else
871     warning (_("unexpected shell command exit status %d"), exit_status);
872 }
873 
874 static void
shell_escape(const char * arg,int from_tty)875 shell_escape (const char *arg, int from_tty)
876 {
877 #if defined(CANT_FORK) || \
878       (!defined(HAVE_WORKING_VFORK) && !defined(HAVE_WORKING_FORK))
879   /* If ARG is NULL, they want an inferior shell, but `system' just
880      reports if the shell is available when passed a NULL arg.  */
881   int rc = system (arg ? arg : "");
882 
883   if (!arg)
884     arg = "inferior shell";
885 
886   if (rc == -1)
887     fprintf_unfiltered (gdb_stderr, "Cannot execute %s: %s\n", arg,
888 			safe_strerror (errno));
889   else if (rc)
890     fprintf_unfiltered (gdb_stderr, "%s exited with status %d\n", arg, rc);
891 #ifdef GLOBAL_CURDIR
892   /* Make sure to return to the directory GDB thinks it is, in case
893      the shell command we just ran changed it.  */
894   chdir (current_directory);
895 #endif
896   exit_status_set_internal_vars (rc);
897 #else /* Can fork.  */
898   int status, pid;
899 
900   if ((pid = vfork ()) == 0)
901     {
902       const char *p, *user_shell = get_shell ();
903 
904       close_most_fds ();
905 
906       /* Get the name of the shell for arg0.  */
907       p = lbasename (user_shell);
908 
909       if (!arg)
910 	execl (user_shell, p, (char *) 0);
911       else
912 	execl (user_shell, p, "-c", arg, (char *) 0);
913 
914       fprintf_unfiltered (gdb_stderr, "Cannot execute %s: %s\n", user_shell,
915 			  safe_strerror (errno));
916       _exit (0177);
917     }
918 
919   if (pid != -1)
920     waitpid (pid, &status, 0);
921   else
922     error (_("Fork failed"));
923   exit_status_set_internal_vars (status);
924 #endif /* Can fork.  */
925 }
926 
927 /* Implementation of the "shell" command.  */
928 
929 static void
shell_command(const char * arg,int from_tty)930 shell_command (const char *arg, int from_tty)
931 {
932   shell_escape (arg, from_tty);
933 }
934 
935 static void
edit_command(const char * arg,int from_tty)936 edit_command (const char *arg, int from_tty)
937 {
938   struct symtab_and_line sal;
939   struct symbol *sym;
940   const char *editor;
941   char *p;
942   const char *fn;
943 
944   /* Pull in the current default source line if necessary.  */
945   if (arg == 0)
946     {
947       set_default_source_symtab_and_line ();
948       sal = get_current_source_symtab_and_line ();
949     }
950 
951   /* Bare "edit" edits file with present line.  */
952 
953   if (arg == 0)
954     {
955       if (sal.symtab == 0)
956 	error (_("No default source file yet."));
957       sal.line += get_lines_to_list () / 2;
958     }
959   else
960     {
961       const char *arg1;
962 
963       /* Now should only be one argument -- decode it in SAL.  */
964       arg1 = arg;
965       event_location_up location = string_to_event_location (&arg1,
966 							     current_language);
967       std::vector<symtab_and_line> sals = decode_line_1 (location.get (),
968 							 DECODE_LINE_LIST_MODE,
969 							 NULL, NULL, 0);
970 
971       filter_sals (sals);
972       if (sals.empty ())
973 	{
974 	  /*  C++  */
975 	  return;
976 	}
977       if (sals.size () > 1)
978 	{
979 	  ambiguous_line_spec (sals,
980 			       _("Specified line is ambiguous:\n"));
981 	  return;
982 	}
983 
984       sal = sals[0];
985 
986       if (*arg1)
987 	error (_("Junk at end of line specification."));
988 
989       /* If line was specified by address, first print exactly which
990 	 line, and which file.  In this case, sal.symtab == 0 means
991 	 address is outside of all known source files, not that user
992 	 failed to give a filename.  */
993       if (*arg == '*')
994 	{
995 	  struct gdbarch *gdbarch;
996 
997 	  if (sal.symtab == 0)
998 	    error (_("No source file for address %s."),
999 		   paddress (get_current_arch (), sal.pc));
1000 
1001 	  gdbarch = SYMTAB_OBJFILE (sal.symtab)->arch ();
1002 	  sym = find_pc_function (sal.pc);
1003 	  if (sym)
1004 	    printf_filtered ("%s is in %s (%s:%d).\n",
1005 			     paddress (gdbarch, sal.pc),
1006 			     sym->print_name (),
1007 			     symtab_to_filename_for_display (sal.symtab),
1008 			     sal.line);
1009 	  else
1010 	    printf_filtered ("%s is at %s:%d.\n",
1011 			     paddress (gdbarch, sal.pc),
1012 			     symtab_to_filename_for_display (sal.symtab),
1013 			     sal.line);
1014 	}
1015 
1016       /* If what was given does not imply a symtab, it must be an
1017 	 undebuggable symbol which means no source code.  */
1018 
1019       if (sal.symtab == 0)
1020 	error (_("No line number known for %s."), arg);
1021     }
1022 
1023   if ((editor = getenv ("EDITOR")) == NULL)
1024     editor = "/bin/ex";
1025 
1026   fn = symtab_to_fullname (sal.symtab);
1027 
1028   /* Quote the file name, in case it has whitespace or other special
1029      characters.  */
1030   p = xstrprintf ("%s +%d \"%s\"", editor, sal.line, fn);
1031   shell_escape (p, from_tty);
1032   xfree (p);
1033 }
1034 
1035 /* The options for the "pipe" command.  */
1036 
1037 struct pipe_cmd_opts
1038 {
1039   /* For "-d".  */
1040   char *delimiter = nullptr;
1041 
~pipe_cmd_optspipe_cmd_opts1042   ~pipe_cmd_opts ()
1043   {
1044     xfree (delimiter);
1045   }
1046 };
1047 
1048 static const gdb::option::option_def pipe_cmd_option_defs[] = {
1049 
1050   gdb::option::string_option_def<pipe_cmd_opts> {
1051     "d",
1052     [] (pipe_cmd_opts *opts) { return &opts->delimiter; },
1053     nullptr,
1054     N_("Indicates to use the specified delimiter string to separate\n\
1055 COMMAND from SHELL_COMMAND, in alternative to |.  This is useful in\n\
1056 case COMMAND contains a | character."),
1057   },
1058 
1059 };
1060 
1061 /* Create an option_def_group for the "pipe" command's options, with
1062    OPTS as context.  */
1063 
1064 static inline gdb::option::option_def_group
make_pipe_cmd_options_def_group(pipe_cmd_opts * opts)1065 make_pipe_cmd_options_def_group (pipe_cmd_opts *opts)
1066 {
1067   return {{pipe_cmd_option_defs}, opts};
1068 }
1069 
1070 /* Implementation of the "pipe" command.  */
1071 
1072 static void
pipe_command(const char * arg,int from_tty)1073 pipe_command (const char *arg, int from_tty)
1074 {
1075   pipe_cmd_opts opts;
1076 
1077   auto grp = make_pipe_cmd_options_def_group (&opts);
1078   gdb::option::process_options
1079     (&arg, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND, grp);
1080 
1081   const char *delim = "|";
1082   if (opts.delimiter != nullptr)
1083     delim = opts.delimiter;
1084 
1085   const char *command = arg;
1086   if (command == nullptr)
1087     error (_("Missing COMMAND"));
1088 
1089   arg = strstr (arg, delim);
1090 
1091   if (arg == nullptr)
1092     error (_("Missing delimiter before SHELL_COMMAND"));
1093 
1094   std::string gdb_cmd (command, arg - command);
1095 
1096   arg += strlen (delim); /* Skip the delimiter.  */
1097 
1098   if (gdb_cmd.empty ())
1099     gdb_cmd = repeat_previous ();
1100 
1101   const char *shell_command = skip_spaces (arg);
1102   if (*shell_command == '\0')
1103     error (_("Missing SHELL_COMMAND"));
1104 
1105   FILE *to_shell_command = popen (shell_command, "w");
1106 
1107   if (to_shell_command == nullptr)
1108     error (_("Error launching \"%s\""), shell_command);
1109 
1110   try
1111     {
1112       stdio_file pipe_file (to_shell_command);
1113 
1114       execute_command_to_ui_file (&pipe_file, gdb_cmd.c_str (), from_tty);
1115     }
1116   catch (...)
1117     {
1118       pclose (to_shell_command);
1119       throw;
1120     }
1121 
1122   int exit_status = pclose (to_shell_command);
1123 
1124   if (exit_status < 0)
1125     error (_("shell command \"%s\" failed: %s"), shell_command,
1126 	   safe_strerror (errno));
1127   exit_status_set_internal_vars (exit_status);
1128 }
1129 
1130 /* Completer for the pipe command.  */
1131 
1132 static void
pipe_command_completer(struct cmd_list_element * ignore,completion_tracker & tracker,const char * text,const char * word_ignored)1133 pipe_command_completer (struct cmd_list_element *ignore,
1134 			completion_tracker &tracker,
1135 			const char *text, const char *word_ignored)
1136 {
1137   pipe_cmd_opts opts;
1138 
1139   const char *org_text = text;
1140   auto grp = make_pipe_cmd_options_def_group (&opts);
1141   if (gdb::option::complete_options
1142       (tracker, &text, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND, grp))
1143     return;
1144 
1145   const char *delimiter = "|";
1146   if (opts.delimiter != nullptr)
1147     delimiter = opts.delimiter;
1148 
1149   /* Check if we're past option values already.  */
1150   if (text > org_text && !isspace (text[-1]))
1151     return;
1152 
1153   const char *delim = strstr (text, delimiter);
1154 
1155   /* If we're still not past the delimiter, complete the gdb
1156      command.  */
1157   if (delim == nullptr || delim == text)
1158     {
1159       complete_nested_command_line (tracker, text);
1160       return;
1161     }
1162 
1163   /* We're past the delimiter.  What follows is a shell command, which
1164      we don't know how to complete.  */
1165 }
1166 
1167 static void
list_command(const char * arg,int from_tty)1168 list_command (const char *arg, int from_tty)
1169 {
1170   struct symbol *sym;
1171   const char *arg1;
1172   int no_end = 1;
1173   int dummy_end = 0;
1174   int dummy_beg = 0;
1175   int linenum_beg = 0;
1176   const char *p;
1177 
1178   /* Pull in the current default source line if necessary.  */
1179   if (arg == NULL || ((arg[0] == '+' || arg[0] == '-') && arg[1] == '\0'))
1180     {
1181       set_default_source_symtab_and_line ();
1182       symtab_and_line cursal = get_current_source_symtab_and_line ();
1183 
1184       /* If this is the first "list" since we've set the current
1185 	 source line, center the listing around that line.  */
1186       if (get_first_line_listed () == 0)
1187 	{
1188 	  int first;
1189 
1190 	  first = std::max (cursal.line - get_lines_to_list () / 2, 1);
1191 
1192 	  /* A small special case --- if listing backwards, and we
1193 	     should list only one line, list the preceding line,
1194 	     instead of the exact line we've just shown after e.g.,
1195 	     stopping for a breakpoint.  */
1196 	  if (arg != NULL && arg[0] == '-'
1197 	      && get_lines_to_list () == 1 && first > 1)
1198 	    first -= 1;
1199 
1200 	  print_source_lines (cursal.symtab, source_lines_range (first), 0);
1201 	}
1202 
1203       /* "l" or "l +" lists next ten lines.  */
1204       else if (arg == NULL || arg[0] == '+')
1205 	print_source_lines (cursal.symtab,
1206 			    source_lines_range (cursal.line), 0);
1207 
1208       /* "l -" lists previous ten lines, the ones before the ten just
1209 	 listed.  */
1210       else if (arg[0] == '-')
1211 	{
1212 	  if (get_first_line_listed () == 1)
1213 	    error (_("Already at the start of %s."),
1214 		   symtab_to_filename_for_display (cursal.symtab));
1215 	  source_lines_range range (get_first_line_listed (),
1216 				    source_lines_range::BACKWARD);
1217 	  print_source_lines (cursal.symtab, range, 0);
1218 	}
1219 
1220       return;
1221     }
1222 
1223   /* Now if there is only one argument, decode it in SAL
1224      and set NO_END.
1225      If there are two arguments, decode them in SAL and SAL_END
1226      and clear NO_END; however, if one of the arguments is blank,
1227      set DUMMY_BEG or DUMMY_END to record that fact.  */
1228 
1229   if (!have_full_symbols () && !have_partial_symbols ())
1230     error (_("No symbol table is loaded.  Use the \"file\" command."));
1231 
1232   std::vector<symtab_and_line> sals;
1233   symtab_and_line sal, sal_end;
1234 
1235   arg1 = arg;
1236   if (*arg1 == ',')
1237     dummy_beg = 1;
1238   else
1239     {
1240       event_location_up location = string_to_event_location (&arg1,
1241 							     current_language);
1242       sals = decode_line_1 (location.get (), DECODE_LINE_LIST_MODE,
1243 			    NULL, NULL, 0);
1244       filter_sals (sals);
1245       if (sals.empty ())
1246 	{
1247 	  /*  C++  */
1248 	  return;
1249 	}
1250 
1251       sal = sals[0];
1252     }
1253 
1254   /* Record whether the BEG arg is all digits.  */
1255 
1256   for (p = arg; p != arg1 && *p >= '0' && *p <= '9'; p++);
1257   linenum_beg = (p == arg1);
1258 
1259   /* Save the range of the first argument, in case we need to let the
1260      user know it was ambiguous.  */
1261   const char *beg = arg;
1262   size_t beg_len = arg1 - beg;
1263 
1264   while (*arg1 == ' ' || *arg1 == '\t')
1265     arg1++;
1266   if (*arg1 == ',')
1267     {
1268       no_end = 0;
1269       if (sals.size () > 1)
1270 	{
1271 	  ambiguous_line_spec (sals,
1272 			       _("Specified first line '%.*s' is ambiguous:\n"),
1273 			       (int) beg_len, beg);
1274 	  return;
1275 	}
1276       arg1++;
1277       while (*arg1 == ' ' || *arg1 == '\t')
1278 	arg1++;
1279       if (*arg1 == 0)
1280 	dummy_end = 1;
1281       else
1282 	{
1283 	  /* Save the last argument, in case we need to let the user
1284 	     know it was ambiguous.  */
1285 	  const char *end_arg = arg1;
1286 
1287 	  event_location_up location
1288 	    = string_to_event_location (&arg1, current_language);
1289 
1290 	  std::vector<symtab_and_line> sals_end
1291 	    = (dummy_beg
1292 	       ? decode_line_1 (location.get (), DECODE_LINE_LIST_MODE,
1293 				NULL, NULL, 0)
1294 	       : decode_line_1 (location.get (), DECODE_LINE_LIST_MODE,
1295 				NULL, sal.symtab, sal.line));
1296 
1297 	  filter_sals (sals_end);
1298 	  if (sals_end.empty ())
1299 	    return;
1300 	  if (sals_end.size () > 1)
1301 	    {
1302 	      ambiguous_line_spec (sals_end,
1303 				   _("Specified last line '%s' is ambiguous:\n"),
1304 				   end_arg);
1305 	      return;
1306 	    }
1307 	  sal_end = sals_end[0];
1308 	}
1309     }
1310 
1311   if (*arg1)
1312     error (_("Junk at end of line specification."));
1313 
1314   if (!no_end && !dummy_beg && !dummy_end
1315       && sal.symtab != sal_end.symtab)
1316     error (_("Specified first and last lines are in different files."));
1317   if (dummy_beg && dummy_end)
1318     error (_("Two empty args do not say what lines to list."));
1319 
1320   /* If line was specified by address,
1321      first print exactly which line, and which file.
1322 
1323      In this case, sal.symtab == 0 means address is outside of all
1324      known source files, not that user failed to give a filename.  */
1325   if (*arg == '*')
1326     {
1327       struct gdbarch *gdbarch;
1328 
1329       if (sal.symtab == 0)
1330 	error (_("No source file for address %s."),
1331 	       paddress (get_current_arch (), sal.pc));
1332 
1333       gdbarch = SYMTAB_OBJFILE (sal.symtab)->arch ();
1334       sym = find_pc_function (sal.pc);
1335       if (sym)
1336 	printf_filtered ("%s is in %s (%s:%d).\n",
1337 			 paddress (gdbarch, sal.pc),
1338 			 sym->print_name (),
1339 			 symtab_to_filename_for_display (sal.symtab), sal.line);
1340       else
1341 	printf_filtered ("%s is at %s:%d.\n",
1342 			 paddress (gdbarch, sal.pc),
1343 			 symtab_to_filename_for_display (sal.symtab), sal.line);
1344     }
1345 
1346   /* If line was not specified by just a line number, and it does not
1347      imply a symtab, it must be an undebuggable symbol which means no
1348      source code.  */
1349 
1350   if (!linenum_beg && sal.symtab == 0)
1351     error (_("No line number known for %s."), arg);
1352 
1353   /* If this command is repeated with RET,
1354      turn it into the no-arg variant.  */
1355 
1356   if (from_tty)
1357     set_repeat_arguments ("");
1358 
1359   if (dummy_beg && sal_end.symtab == 0)
1360     error (_("No default source file yet.  Do \"help list\"."));
1361   if (dummy_beg)
1362     {
1363       source_lines_range range (sal_end.line + 1,
1364 				source_lines_range::BACKWARD);
1365       print_source_lines (sal_end.symtab, range, 0);
1366     }
1367   else if (sal.symtab == 0)
1368     error (_("No default source file yet.  Do \"help list\"."));
1369   else if (no_end)
1370     {
1371       for (int i = 0; i < sals.size (); i++)
1372 	{
1373 	  sal = sals[i];
1374 	  int first_line = sal.line - get_lines_to_list () / 2;
1375 	  if (first_line < 1)
1376 	    first_line = 1;
1377 	  if (sals.size () > 1)
1378 	    print_sal_location (sal);
1379 	  print_source_lines (sal.symtab, source_lines_range (first_line), 0);
1380 	}
1381     }
1382   else if (dummy_end)
1383     print_source_lines (sal.symtab, source_lines_range (sal.line), 0);
1384   else
1385     print_source_lines (sal.symtab,
1386 			source_lines_range (sal.line, (sal_end.line + 1)),
1387 			0);
1388 }
1389 
1390 /* Subroutine of disassemble_command to simplify it.
1391    Perform the disassembly.
1392    NAME is the name of the function if known, or NULL.
1393    [LOW,HIGH) are the range of addresses to disassemble.
1394    BLOCK is the block to disassemble; it needs to be provided
1395    when non-contiguous blocks are disassembled; otherwise
1396    it can be NULL.
1397    MIXED is non-zero to print source with the assembler.  */
1398 
1399 static void
print_disassembly(struct gdbarch * gdbarch,const char * name,CORE_ADDR low,CORE_ADDR high,const struct block * block,gdb_disassembly_flags flags)1400 print_disassembly (struct gdbarch *gdbarch, const char *name,
1401 		   CORE_ADDR low, CORE_ADDR high,
1402 		   const struct block *block,
1403 		   gdb_disassembly_flags flags)
1404 {
1405 #if defined(TUI)
1406   if (tui_is_window_visible (DISASSEM_WIN))
1407     tui_show_assembly (gdbarch, low);
1408   else
1409 #endif
1410     {
1411       printf_filtered (_("Dump of assembler code "));
1412       if (name != NULL)
1413 	printf_filtered (_("for function %ps:\n"),
1414 			 styled_string (function_name_style.style (), name));
1415       if (block == nullptr || BLOCK_CONTIGUOUS_P (block))
1416 	{
1417 	  if (name == NULL)
1418 	    printf_filtered (_("from %ps to %ps:\n"),
1419 			     styled_string (address_style.style (),
1420 					    paddress (gdbarch, low)),
1421 			     styled_string (address_style.style (),
1422 					    paddress (gdbarch, high)));
1423 
1424 	  /* Dump the specified range.  */
1425 	  gdb_disassembly (gdbarch, current_uiout, flags, -1, low, high);
1426 	}
1427       else
1428 	{
1429 	  for (int i = 0; i < BLOCK_NRANGES (block); i++)
1430 	    {
1431 	      CORE_ADDR range_low = BLOCK_RANGE_START (block, i);
1432 	      CORE_ADDR range_high = BLOCK_RANGE_END (block, i);
1433 	      printf_filtered (_("Address range %ps to %ps:\n"),
1434 			       styled_string (address_style.style (),
1435 					      paddress (gdbarch, range_low)),
1436 			       styled_string (address_style.style (),
1437 					      paddress (gdbarch, range_high)));
1438 	      gdb_disassembly (gdbarch, current_uiout, flags, -1,
1439 			       range_low, range_high);
1440 	    }
1441 	}
1442       printf_filtered (_("End of assembler dump.\n"));
1443     }
1444 }
1445 
1446 /* Subroutine of disassemble_command to simplify it.
1447    Print a disassembly of the current function according to FLAGS.  */
1448 
1449 static void
disassemble_current_function(gdb_disassembly_flags flags)1450 disassemble_current_function (gdb_disassembly_flags flags)
1451 {
1452   struct frame_info *frame;
1453   struct gdbarch *gdbarch;
1454   CORE_ADDR low, high, pc;
1455   const char *name;
1456   const struct block *block;
1457 
1458   frame = get_selected_frame (_("No frame selected."));
1459   gdbarch = get_frame_arch (frame);
1460   pc = get_frame_address_in_block (frame);
1461   if (find_pc_partial_function (pc, &name, &low, &high, &block) == 0)
1462     error (_("No function contains program counter for selected frame."));
1463 #if defined(TUI)
1464   /* NOTE: cagney/2003-02-13 The `tui_active' was previously
1465      `tui_version'.  */
1466   if (tui_active)
1467     /* FIXME: cagney/2004-02-07: This should be an observer.  */
1468     low = tui_get_low_disassembly_address (gdbarch, low, pc);
1469 #endif
1470   low += gdbarch_deprecated_function_start_offset (gdbarch);
1471 
1472   print_disassembly (gdbarch, name, low, high, block, flags);
1473 }
1474 
1475 /* Dump a specified section of assembly code.
1476 
1477    Usage:
1478      disassemble [/mrs]
1479        - dump the assembly code for the function of the current pc
1480      disassemble [/mrs] addr
1481        - dump the assembly code for the function at ADDR
1482      disassemble [/mrs] low,high
1483      disassemble [/mrs] low,+length
1484        - dump the assembly code in the range [LOW,HIGH), or [LOW,LOW+length)
1485 
1486    A /m modifier will include source code with the assembly in a
1487    "source centric" view.  This view lists only the file of the first insn,
1488    even if other source files are involved (e.g., inlined functions), and
1489    the output is in source order, even with optimized code.  This view is
1490    considered deprecated as it hasn't been useful in practice.
1491 
1492    A /r modifier will include raw instructions in hex with the assembly.
1493 
1494    A /s modifier will include source code with the assembly, like /m, with
1495    two important differences:
1496    1) The output is still in pc address order.
1497    2) File names and contents for all relevant source files are displayed.  */
1498 
1499 static void
disassemble_command(const char * arg,int from_tty)1500 disassemble_command (const char *arg, int from_tty)
1501 {
1502   struct gdbarch *gdbarch = get_current_arch ();
1503   CORE_ADDR low, high;
1504   const general_symbol_info *symbol = nullptr;
1505   const char *name;
1506   CORE_ADDR pc;
1507   gdb_disassembly_flags flags;
1508   const char *p;
1509   const struct block *block = nullptr;
1510 
1511   p = arg;
1512   name = NULL;
1513   flags = 0;
1514 
1515   if (p && *p == '/')
1516     {
1517       ++p;
1518 
1519       if (*p == '\0')
1520 	error (_("Missing modifier."));
1521 
1522       while (*p && ! isspace (*p))
1523 	{
1524 	  switch (*p++)
1525 	    {
1526 	    case 'm':
1527 	      flags |= DISASSEMBLY_SOURCE_DEPRECATED;
1528 	      break;
1529 	    case 'r':
1530 	      flags |= DISASSEMBLY_RAW_INSN;
1531 	      break;
1532 	    case 's':
1533 	      flags |= DISASSEMBLY_SOURCE;
1534 	      break;
1535 	    default:
1536 	      error (_("Invalid disassembly modifier."));
1537 	    }
1538 	}
1539 
1540       p = skip_spaces (p);
1541     }
1542 
1543   if ((flags & (DISASSEMBLY_SOURCE_DEPRECATED | DISASSEMBLY_SOURCE))
1544       == (DISASSEMBLY_SOURCE_DEPRECATED | DISASSEMBLY_SOURCE))
1545     error (_("Cannot specify both /m and /s."));
1546 
1547   if (! p || ! *p)
1548     {
1549       flags |= DISASSEMBLY_OMIT_FNAME;
1550       disassemble_current_function (flags);
1551       return;
1552     }
1553 
1554   pc = value_as_address (parse_to_comma_and_eval (&p));
1555   if (p[0] == ',')
1556     ++p;
1557   if (p[0] == '\0')
1558     {
1559       /* One argument.  */
1560       if (!find_pc_partial_function_sym (pc, &symbol, &low, &high, &block))
1561 	error (_("No function contains specified address."));
1562 
1563       if (asm_demangle)
1564 	name = symbol->print_name ();
1565       else
1566 	name = symbol->linkage_name ();
1567 
1568 #if defined(TUI)
1569       /* NOTE: cagney/2003-02-13 The `tui_active' was previously
1570 	 `tui_version'.  */
1571       if (tui_active)
1572 	/* FIXME: cagney/2004-02-07: This should be an observer.  */
1573 	low = tui_get_low_disassembly_address (gdbarch, low, pc);
1574 #endif
1575       low += gdbarch_deprecated_function_start_offset (gdbarch);
1576       flags |= DISASSEMBLY_OMIT_FNAME;
1577     }
1578   else
1579     {
1580       /* Two arguments.  */
1581       int incl_flag = 0;
1582       low = pc;
1583       p = skip_spaces (p);
1584       if (p[0] == '+')
1585 	{
1586 	  ++p;
1587 	  incl_flag = 1;
1588 	}
1589       high = parse_and_eval_address (p);
1590       if (incl_flag)
1591 	high += low;
1592     }
1593 
1594   print_disassembly (gdbarch, name, low, high, block, flags);
1595 }
1596 
1597 static void
make_command(const char * arg,int from_tty)1598 make_command (const char *arg, int from_tty)
1599 {
1600   if (arg == 0)
1601     shell_escape ("make", from_tty);
1602   else
1603     {
1604       std::string cmd = std::string ("make ") + arg;
1605 
1606       shell_escape (cmd.c_str (), from_tty);
1607     }
1608 }
1609 
1610 static void
show_user(const char * args,int from_tty)1611 show_user (const char *args, int from_tty)
1612 {
1613   struct cmd_list_element *c;
1614 
1615   if (args)
1616     {
1617       const char *comname = args;
1618 
1619       c = lookup_cmd (&comname, cmdlist, "", NULL, 0, 1);
1620       if (!cli_user_command_p (c))
1621 	error (_("Not a user command."));
1622       show_user_1 (c, "", args, gdb_stdout);
1623     }
1624   else
1625     {
1626       for (c = cmdlist; c; c = c->next)
1627 	{
1628 	  if (cli_user_command_p (c) || c->is_prefix ())
1629 	    show_user_1 (c, "", c->name, gdb_stdout);
1630 	}
1631     }
1632 }
1633 
1634 /* Search through names of commands and documentations for a certain
1635    regular expression.  */
1636 
1637 static void
apropos_command(const char * arg,int from_tty)1638 apropos_command (const char *arg, int from_tty)
1639 {
1640   bool verbose = arg && check_for_argument (&arg, "-v", 2);
1641 
1642   if (arg == NULL || *arg == '\0')
1643     error (_("REGEXP string is empty"));
1644 
1645   compiled_regex pattern (arg, REG_ICASE,
1646 			  _("Error in regular expression"));
1647 
1648   apropos_cmd (gdb_stdout, cmdlist, verbose, pattern, "");
1649 }
1650 
1651 /* The options for the "alias" command.  */
1652 
1653 struct alias_opts
1654 {
1655   /* For "-a".  */
1656   bool abbrev_flag = false;
1657 };
1658 
1659 static const gdb::option::option_def alias_option_defs[] = {
1660 
1661   gdb::option::flag_option_def<alias_opts> {
1662     "a",
1663     [] (alias_opts *opts) { return &opts->abbrev_flag; },
1664     N_("Specify that ALIAS is an abbreviation of COMMAND.\n\
1665 Abbreviations are not used in command completion."),
1666   },
1667 
1668 };
1669 
1670 /* Create an option_def_group for the "alias" options, with
1671    A_OPTS as context.  */
1672 
1673 static gdb::option::option_def_group
make_alias_options_def_group(alias_opts * a_opts)1674 make_alias_options_def_group (alias_opts *a_opts)
1675 {
1676   return {{alias_option_defs}, a_opts};
1677 }
1678 
1679 /* Completer for the "alias_command".  */
1680 
1681 static void
alias_command_completer(struct cmd_list_element * ignore,completion_tracker & tracker,const char * text,const char * word)1682 alias_command_completer (struct cmd_list_element *ignore,
1683 			 completion_tracker &tracker,
1684 			 const char *text, const char *word)
1685 {
1686   const auto grp = make_alias_options_def_group (nullptr);
1687 
1688   tracker.set_use_custom_word_point (true);
1689 
1690   if (gdb::option::complete_options
1691       (tracker, &text, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_ERROR, grp))
1692     return;
1693 
1694   const char *delim = strchr (text, '=');
1695 
1696   /* If we're past the "=" delimiter, complete the
1697      "alias ALIAS = COMMAND [DEFAULT-ARGS...]" as if the user is
1698      typing COMMAND DEFAULT-ARGS...  */
1699   if (delim != text
1700       && delim != nullptr
1701       && isspace (delim[-1])
1702       && (isspace (delim[1]) || delim[1] == '\0'))
1703     {
1704       std::string new_text = std::string (delim + 1);
1705 
1706       tracker.advance_custom_word_point_by (delim + 1 - text);
1707       complete_nested_command_line (tracker, new_text.c_str ());
1708       return;
1709     }
1710 
1711   /* We're not yet past the "=" delimiter.  Complete a command, as
1712      the user might type an alias following a prefix command.  */
1713   complete_nested_command_line (tracker, text);
1714 }
1715 
1716 /* Subroutine of alias_command to simplify it.
1717    Return the first N elements of ARGV flattened back to a string
1718    with a space separating each element.
1719    ARGV may not be NULL.
1720    This does not take care of quoting elements in case they contain spaces
1721    on purpose.  */
1722 
1723 static std::string
argv_to_string(char ** argv,int n)1724 argv_to_string (char **argv, int n)
1725 {
1726   int i;
1727   std::string result;
1728 
1729   gdb_assert (argv != NULL);
1730   gdb_assert (n >= 0 && n <= countargv (argv));
1731 
1732   for (i = 0; i < n; ++i)
1733     {
1734       if (i > 0)
1735 	result += " ";
1736       result += argv[i];
1737     }
1738 
1739   return result;
1740 }
1741 
1742 /* Subroutine of alias_command to simplify it.
1743    Verifies that COMMAND can have an alias:
1744       COMMAND must exist.
1745       COMMAND must not have default args.
1746    This last condition is to avoid the following:
1747      alias aaa = backtrace -full
1748      alias bbb = aaa -past-main
1749    as (at least currently), alias default args are not cumulative
1750    and the user would expect bbb to execute 'backtrace -full -past-main'
1751    while it will execute 'backtrace -past-main'.  */
1752 
1753 static cmd_list_element *
validate_aliased_command(const char * command)1754 validate_aliased_command (const char *command)
1755 {
1756   std::string default_args;
1757   cmd_list_element *c
1758     = lookup_cmd_1 (& command, cmdlist, NULL, &default_args, 1);
1759 
1760   if (c == NULL || c == (struct cmd_list_element *) -1)
1761     error (_("Invalid command to alias to: %s"), command);
1762 
1763   if (!default_args.empty ())
1764     error (_("Cannot define an alias of an alias that has default args"));
1765 
1766   return c;
1767 }
1768 
1769 /* Called when "alias" was incorrectly used.  */
1770 
1771 static void
alias_usage_error(void)1772 alias_usage_error (void)
1773 {
1774   error (_("Usage: alias [-a] [--] ALIAS = COMMAND [DEFAULT-ARGS...]"));
1775 }
1776 
1777 /* Make an alias of an existing command.  */
1778 
1779 static void
alias_command(const char * args,int from_tty)1780 alias_command (const char *args, int from_tty)
1781 {
1782   alias_opts a_opts;
1783 
1784   auto grp = make_alias_options_def_group (&a_opts);
1785   gdb::option::process_options
1786     (&args, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_ERROR, grp);
1787 
1788   int i, alias_argc, command_argc;
1789   const char *equals;
1790   const char *alias, *command;
1791 
1792   if (args == NULL || strchr (args, '=') == NULL)
1793     alias_usage_error ();
1794 
1795   equals = strchr (args, '=');
1796   std::string args2 (args, equals - args);
1797 
1798   gdb_argv built_alias_argv (args2.c_str ());
1799 
1800   const char *default_args = equals + 1;
1801   struct cmd_list_element *c_command_prefix;
1802 
1803   lookup_cmd_for_default_args (&default_args, &c_command_prefix);
1804   std::string command_argv_str (equals + 1,
1805 				default_args == nullptr
1806 				? strlen (equals + 1)
1807 				: default_args - equals - 1);
1808   gdb_argv command_argv (command_argv_str.c_str ());
1809 
1810   char **alias_argv = built_alias_argv.get ();
1811 
1812   if (alias_argv[0] == NULL || command_argv[0] == NULL
1813       || *alias_argv[0] == '\0' || *command_argv[0] == '\0')
1814     alias_usage_error ();
1815 
1816   for (i = 0; alias_argv[i] != NULL; ++i)
1817     {
1818       if (! valid_user_defined_cmd_name_p (alias_argv[i]))
1819 	{
1820 	  if (i == 0)
1821 	    error (_("Invalid command name: %s"), alias_argv[i]);
1822 	  else
1823 	    error (_("Invalid command element name: %s"), alias_argv[i]);
1824 	}
1825     }
1826 
1827   alias_argc = countargv (alias_argv);
1828   command_argc = command_argv.count ();
1829 
1830   /* COMMAND must exist, and cannot have default args.
1831      Reconstruct the command to remove any extraneous spaces,
1832      for better error messages.  */
1833   std::string command_string (argv_to_string (command_argv.get (),
1834 					      command_argc));
1835   command = command_string.c_str ();
1836   cmd_list_element *target_cmd = validate_aliased_command (command);
1837 
1838   /* ALIAS must not exist.  */
1839   std::string alias_string (argv_to_string (alias_argv, alias_argc));
1840   alias = alias_string.c_str ();
1841   {
1842     cmd_list_element *alias_cmd, *prefix_cmd, *cmd;
1843 
1844     if (lookup_cmd_composition (alias, &alias_cmd, &prefix_cmd, &cmd))
1845       {
1846 	const char *alias_name = alias_argv[alias_argc-1];
1847 
1848 	/* If we found an existing ALIAS_CMD, check that the prefix differ or
1849 	   the name differ.  */
1850 
1851 	if (alias_cmd != nullptr
1852 	    && alias_cmd->prefix == prefix_cmd
1853 	    && strcmp (alias_name, alias_cmd->name) == 0)
1854 	  error (_("Alias already exists: %s"), alias);
1855 
1856 	/* Check ALIAS differs from the found CMD.  */
1857 
1858 	if (cmd->prefix == prefix_cmd
1859 	    && strcmp (alias_name, cmd->name) == 0)
1860 	  error (_("Alias %s is the name of an existing command"), alias);
1861       }
1862   }
1863 
1864 
1865   struct cmd_list_element *alias_cmd;
1866 
1867   /* If ALIAS is one word, it is an alias for the entire COMMAND.
1868      Example: alias spe = set print elements
1869 
1870      Otherwise ALIAS and COMMAND must have the same number of words,
1871      and every word except the last must identify the same prefix command;
1872      and the last word of ALIAS is made an alias of the last word of COMMAND.
1873      Example: alias set print elms = set pr elem
1874      Note that unambiguous abbreviations are allowed.  */
1875 
1876   if (alias_argc == 1)
1877     {
1878       /* add_cmd requires *we* allocate space for name, hence the xstrdup.  */
1879       alias_cmd = add_com_alias (xstrdup (alias_argv[0]), target_cmd,
1880 				 class_alias, a_opts.abbrev_flag);
1881     }
1882   else
1883     {
1884       const char *alias_prefix, *command_prefix;
1885       struct cmd_list_element *c_alias, *c_command;
1886 
1887       if (alias_argc != command_argc)
1888 	error (_("Mismatched command length between ALIAS and COMMAND."));
1889 
1890       /* Create copies of ALIAS and COMMAND without the last word,
1891 	 and use that to verify the leading elements give the same
1892 	 prefix command.  */
1893       std::string alias_prefix_string (argv_to_string (alias_argv,
1894 						       alias_argc - 1));
1895       std::string command_prefix_string (argv_to_string (command_argv.get (),
1896 							 command_argc - 1));
1897       alias_prefix = alias_prefix_string.c_str ();
1898       command_prefix = command_prefix_string.c_str ();
1899 
1900       c_command = lookup_cmd_1 (& command_prefix, cmdlist, NULL, NULL, 1);
1901       /* We've already tried to look up COMMAND.  */
1902       gdb_assert (c_command != NULL
1903 		  && c_command != (struct cmd_list_element *) -1);
1904       gdb_assert (c_command->is_prefix ());
1905       c_alias = lookup_cmd_1 (& alias_prefix, cmdlist, NULL, NULL, 1);
1906       if (c_alias != c_command)
1907 	error (_("ALIAS and COMMAND prefixes do not match."));
1908 
1909       /* add_cmd requires *we* allocate space for name, hence the xstrdup.  */
1910       alias_cmd = add_alias_cmd (xstrdup (alias_argv[alias_argc - 1]),
1911 				 target_cmd, class_alias, a_opts.abbrev_flag,
1912 				 c_command->subcommands);
1913     }
1914 
1915   gdb_assert (alias_cmd != nullptr);
1916   gdb_assert (alias_cmd->default_args.empty ());
1917   if (default_args != nullptr)
1918     {
1919       default_args = skip_spaces (default_args);
1920 
1921       alias_cmd->default_args = default_args;
1922     }
1923 }
1924 
1925 /* Print the file / line number / symbol name of the location
1926    specified by SAL.  */
1927 
1928 static void
print_sal_location(const symtab_and_line & sal)1929 print_sal_location (const symtab_and_line &sal)
1930 {
1931   scoped_restore_current_program_space restore_pspace;
1932   set_current_program_space (sal.pspace);
1933 
1934   const char *sym_name = NULL;
1935   if (sal.symbol != NULL)
1936     sym_name = sal.symbol->print_name ();
1937   printf_filtered (_("file: \"%s\", line number: %d, symbol: \"%s\"\n"),
1938 		   symtab_to_filename_for_display (sal.symtab),
1939 		   sal.line, sym_name != NULL ? sym_name : "???");
1940 }
1941 
1942 /* Print a list of files and line numbers which a user may choose from
1943    in order to list a function which was specified ambiguously (as
1944    with `list classname::overloadedfuncname', for example).  The SALS
1945    array provides the filenames and line numbers.  FORMAT is a
1946    printf-style format string used to tell the user what was
1947    ambiguous.  */
1948 
1949 static void
ambiguous_line_spec(gdb::array_view<const symtab_and_line> sals,const char * format,...)1950 ambiguous_line_spec (gdb::array_view<const symtab_and_line> sals,
1951 		     const char *format, ...)
1952 {
1953   va_list ap;
1954   va_start (ap, format);
1955   vprintf_filtered (format, ap);
1956   va_end (ap);
1957 
1958   for (const auto &sal : sals)
1959     print_sal_location (sal);
1960 }
1961 
1962 /* Comparison function for filter_sals.  Returns a qsort-style
1963    result.  */
1964 
1965 static int
cmp_symtabs(const symtab_and_line & sala,const symtab_and_line & salb)1966 cmp_symtabs (const symtab_and_line &sala, const symtab_and_line &salb)
1967 {
1968   const char *dira = SYMTAB_DIRNAME (sala.symtab);
1969   const char *dirb = SYMTAB_DIRNAME (salb.symtab);
1970   int r;
1971 
1972   if (dira == NULL)
1973     {
1974       if (dirb != NULL)
1975 	return -1;
1976     }
1977   else if (dirb == NULL)
1978     {
1979       if (dira != NULL)
1980 	return 1;
1981     }
1982   else
1983     {
1984       r = filename_cmp (dira, dirb);
1985       if (r)
1986 	return r;
1987     }
1988 
1989   r = filename_cmp (sala.symtab->filename, salb.symtab->filename);
1990   if (r)
1991     return r;
1992 
1993   if (sala.line < salb.line)
1994     return -1;
1995   return sala.line == salb.line ? 0 : 1;
1996 }
1997 
1998 /* Remove any SALs that do not match the current program space, or
1999    which appear to be "file:line" duplicates.  */
2000 
2001 static void
filter_sals(std::vector<symtab_and_line> & sals)2002 filter_sals (std::vector<symtab_and_line> &sals)
2003 {
2004   /* Remove SALs that do not match.  */
2005   auto from = std::remove_if (sals.begin (), sals.end (),
2006 			      [&] (const symtab_and_line &sal)
2007     { return (sal.pspace != current_program_space || sal.symtab == NULL); });
2008 
2009   /* Remove dups.  */
2010   std::sort (sals.begin (), from,
2011 	     [] (const symtab_and_line &sala, const symtab_and_line &salb)
2012    { return cmp_symtabs (sala, salb) < 0; });
2013 
2014   from = std::unique (sals.begin (), from,
2015 		      [&] (const symtab_and_line &sala,
2016 			   const symtab_and_line &salb)
2017     { return cmp_symtabs (sala, salb) == 0; });
2018 
2019   sals.erase (from, sals.end ());
2020 }
2021 
2022 void
init_cmd_lists(void)2023 init_cmd_lists (void)
2024 {
2025   max_user_call_depth = 1024;
2026 }
2027 
2028 static void
show_info_verbose(struct ui_file * file,int from_tty,struct cmd_list_element * c,const char * value)2029 show_info_verbose (struct ui_file *file, int from_tty,
2030 		   struct cmd_list_element *c,
2031 		   const char *value)
2032 {
2033   if (info_verbose)
2034     fprintf_filtered (file,
2035 		      _("Verbose printing of informational messages is %s.\n"),
2036 		      value);
2037   else
2038     fprintf_filtered (file, _("Verbosity is %s.\n"), value);
2039 }
2040 
2041 static void
show_history_expansion_p(struct ui_file * file,int from_tty,struct cmd_list_element * c,const char * value)2042 show_history_expansion_p (struct ui_file *file, int from_tty,
2043 			  struct cmd_list_element *c, const char *value)
2044 {
2045   fprintf_filtered (file, _("History expansion on command input is %s.\n"),
2046 		    value);
2047 }
2048 
2049 static void
show_max_user_call_depth(struct ui_file * file,int from_tty,struct cmd_list_element * c,const char * value)2050 show_max_user_call_depth (struct ui_file *file, int from_tty,
2051 			  struct cmd_list_element *c, const char *value)
2052 {
2053   fprintf_filtered (file,
2054 		    _("The max call depth for user-defined commands is %s.\n"),
2055 		    value);
2056 }
2057 
2058 /* Returns the cmd_list_element in SHOWLIST corresponding to the first
2059    argument of ARGV, which must contain one single value.
2060    Throws an error if no value provided, or value not correct.
2061    FNNAME is used in the error message.  */
2062 
2063 static cmd_list_element *
setting_cmd(const char * fnname,struct cmd_list_element * showlist,int argc,struct value ** argv)2064 setting_cmd (const char *fnname, struct cmd_list_element *showlist,
2065 	     int argc, struct value **argv)
2066 {
2067   if (argc == 0)
2068     error (_("You must provide an argument to %s"), fnname);
2069   if (argc != 1)
2070     error (_("You can only provide one argument to %s"), fnname);
2071 
2072   struct type *type0 = check_typedef (value_type (argv[0]));
2073 
2074   if (type0->code () != TYPE_CODE_ARRAY
2075       && type0->code () != TYPE_CODE_STRING)
2076     error (_("First argument of %s must be a string."), fnname);
2077 
2078   const char *a0 = (const char *) value_contents (argv[0]);
2079   cmd_list_element *cmd = lookup_cmd (&a0, showlist, "", NULL, -1, 0);
2080 
2081   if (cmd == nullptr || cmd->type != show_cmd)
2082     error (_("First argument of %s must be a "
2083 	     "valid setting of the 'show' command."), fnname);
2084 
2085   return cmd;
2086 }
2087 
2088 /* Builds a value from the show CMD.  */
2089 
2090 static struct value *
value_from_setting(const cmd_list_element * cmd,struct gdbarch * gdbarch)2091 value_from_setting (const cmd_list_element *cmd, struct gdbarch *gdbarch)
2092 {
2093   switch (cmd->var_type)
2094     {
2095     case var_integer:
2096       if (*(int *) cmd->var == INT_MAX)
2097 	return value_from_longest (builtin_type (gdbarch)->builtin_int,
2098 				   0);
2099       else
2100 	return value_from_longest (builtin_type (gdbarch)->builtin_int,
2101 				   *(int *) cmd->var);
2102     case var_zinteger:
2103       return value_from_longest (builtin_type (gdbarch)->builtin_int,
2104 				 *(int *) cmd->var);
2105     case var_boolean:
2106       return value_from_longest (builtin_type (gdbarch)->builtin_int,
2107 				 *(bool *) cmd->var ? 1 : 0);
2108     case var_zuinteger_unlimited:
2109       return value_from_longest (builtin_type (gdbarch)->builtin_int,
2110 				 *(int *) cmd->var);
2111     case var_auto_boolean:
2112       {
2113 	int val;
2114 
2115 	switch (*(enum auto_boolean*) cmd->var)
2116 	  {
2117 	  case AUTO_BOOLEAN_TRUE:
2118 	    val = 1;
2119 	    break;
2120 	  case AUTO_BOOLEAN_FALSE:
2121 	    val = 0;
2122 	    break;
2123 	  case AUTO_BOOLEAN_AUTO:
2124 	    val = -1;
2125 	    break;
2126 	  default:
2127 	    gdb_assert_not_reached ("invalid var_auto_boolean");
2128 	  }
2129 	return value_from_longest (builtin_type (gdbarch)->builtin_int,
2130 				   val);
2131       }
2132     case var_uinteger:
2133       if (*(unsigned int *) cmd->var == UINT_MAX)
2134 	return value_from_ulongest
2135 	  (builtin_type (gdbarch)->builtin_unsigned_int, 0);
2136       else
2137 	return value_from_ulongest
2138 	  (builtin_type (gdbarch)->builtin_unsigned_int,
2139 	   *(unsigned int *) cmd->var);
2140     case var_zuinteger:
2141       return value_from_ulongest (builtin_type (gdbarch)->builtin_unsigned_int,
2142 				  *(unsigned int *) cmd->var);
2143     case var_string:
2144     case var_string_noescape:
2145     case var_optional_filename:
2146     case var_filename:
2147     case var_enum:
2148       if (*(char **) cmd->var)
2149 	return value_cstring (*(char **) cmd->var, strlen (*(char **) cmd->var),
2150 			      builtin_type (gdbarch)->builtin_char);
2151       else
2152 	return value_cstring ("", 1,
2153 			      builtin_type (gdbarch)->builtin_char);
2154     default:
2155       gdb_assert_not_reached ("bad var_type");
2156     }
2157 }
2158 
2159 /* Implementation of the convenience function $_gdb_setting.  */
2160 
2161 static struct value *
gdb_setting_internal_fn(struct gdbarch * gdbarch,const struct language_defn * language,void * cookie,int argc,struct value ** argv)2162 gdb_setting_internal_fn (struct gdbarch *gdbarch,
2163 			 const struct language_defn *language,
2164 			 void *cookie, int argc, struct value **argv)
2165 {
2166   return value_from_setting (setting_cmd ("$_gdb_setting", showlist,
2167 					  argc, argv),
2168 			     gdbarch);
2169 }
2170 
2171 /* Implementation of the convenience function $_gdb_maint_setting.  */
2172 
2173 static struct value *
gdb_maint_setting_internal_fn(struct gdbarch * gdbarch,const struct language_defn * language,void * cookie,int argc,struct value ** argv)2174 gdb_maint_setting_internal_fn (struct gdbarch *gdbarch,
2175 			       const struct language_defn *language,
2176 			       void *cookie, int argc, struct value **argv)
2177 {
2178   return value_from_setting (setting_cmd ("$_gdb_maint_setting",
2179 					  maintenance_show_cmdlist,
2180 					  argc, argv),
2181 			     gdbarch);
2182 }
2183 
2184 /* Builds a string value from the show CMD.  */
2185 
2186 static struct value *
str_value_from_setting(const cmd_list_element * cmd,struct gdbarch * gdbarch)2187 str_value_from_setting (const cmd_list_element *cmd, struct gdbarch *gdbarch)
2188 {
2189   switch (cmd->var_type)
2190     {
2191     case var_integer:
2192     case var_zinteger:
2193     case var_boolean:
2194     case var_zuinteger_unlimited:
2195     case var_auto_boolean:
2196     case var_uinteger:
2197     case var_zuinteger:
2198       {
2199 	std::string cmd_val = get_setshow_command_value_string (cmd);
2200 
2201 	return value_cstring (cmd_val.c_str (), cmd_val.size (),
2202 			      builtin_type (gdbarch)->builtin_char);
2203       }
2204 
2205     case var_string:
2206     case var_string_noescape:
2207     case var_optional_filename:
2208     case var_filename:
2209     case var_enum:
2210       /* For these cases, we do not use get_setshow_command_value_string,
2211 	 as this function handle some characters specially, e.g. by
2212 	 escaping quotes.  So, we directly use the cmd->var string value,
2213 	 similarly to the value_from_setting code for these cases.  */
2214       if (*(char **) cmd->var)
2215 	return value_cstring (*(char **) cmd->var, strlen (*(char **) cmd->var),
2216 			      builtin_type (gdbarch)->builtin_char);
2217       else
2218 	return value_cstring ("", 1,
2219 			      builtin_type (gdbarch)->builtin_char);
2220 
2221     default:
2222       gdb_assert_not_reached ("bad var_type");
2223     }
2224 }
2225 
2226 /* Implementation of the convenience function $_gdb_setting_str.  */
2227 
2228 static struct value *
gdb_setting_str_internal_fn(struct gdbarch * gdbarch,const struct language_defn * language,void * cookie,int argc,struct value ** argv)2229 gdb_setting_str_internal_fn (struct gdbarch *gdbarch,
2230 			     const struct language_defn *language,
2231 			     void *cookie, int argc, struct value **argv)
2232 {
2233   return str_value_from_setting (setting_cmd ("$_gdb_setting_str",
2234 					      showlist, argc, argv),
2235 				 gdbarch);
2236 }
2237 
2238 
2239 /* Implementation of the convenience function $_gdb_maint_setting_str.  */
2240 
2241 static struct value *
gdb_maint_setting_str_internal_fn(struct gdbarch * gdbarch,const struct language_defn * language,void * cookie,int argc,struct value ** argv)2242 gdb_maint_setting_str_internal_fn (struct gdbarch *gdbarch,
2243 				   const struct language_defn *language,
2244 				   void *cookie, int argc, struct value **argv)
2245 {
2246   return str_value_from_setting (setting_cmd ("$_gdb_maint_setting_str",
2247 					      maintenance_show_cmdlist,
2248 					      argc, argv),
2249 				 gdbarch);
2250 }
2251 
2252 void _initialize_cli_cmds ();
2253 void
_initialize_cli_cmds()2254 _initialize_cli_cmds ()
2255 {
2256   struct cmd_list_element *c;
2257 
2258   /* Define the classes of commands.
2259      They will appear in the help list in alphabetical order.  */
2260 
2261   add_cmd ("internals", class_maintenance, _("\
2262 Maintenance commands.\n\
2263 Some gdb commands are provided just for use by gdb maintainers.\n\
2264 These commands are subject to frequent change, and may not be as\n\
2265 well documented as user commands."),
2266 	   &cmdlist);
2267   add_cmd ("obscure", class_obscure, _("Obscure features."), &cmdlist);
2268   add_cmd ("aliases", class_alias,
2269 	   _("User-defined aliases of other commands."), &cmdlist);
2270   add_cmd ("user-defined", class_user, _("\
2271 User-defined commands.\n\
2272 The commands in this class are those defined by the user.\n\
2273 Use the \"define\" command to define a command."), &cmdlist);
2274   add_cmd ("support", class_support, _("Support facilities."), &cmdlist);
2275   if (!dbx_commands)
2276     add_cmd ("status", class_info, _("Status inquiries."), &cmdlist);
2277   add_cmd ("files", class_files, _("Specifying and examining files."),
2278 	   &cmdlist);
2279   add_cmd ("breakpoints", class_breakpoint,
2280 	   _("Making program stop at certain points."), &cmdlist);
2281   add_cmd ("data", class_vars, _("Examining data."), &cmdlist);
2282   add_cmd ("stack", class_stack, _("\
2283 Examining the stack.\n\
2284 The stack is made up of stack frames.  Gdb assigns numbers to stack frames\n\
2285 counting from zero for the innermost (currently executing) frame.\n\n\
2286 At any time gdb identifies one frame as the \"selected\" frame.\n\
2287 Variable lookups are done with respect to the selected frame.\n\
2288 When the program being debugged stops, gdb selects the innermost frame.\n\
2289 The commands below can be used to select other frames by number or address."),
2290 	   &cmdlist);
2291 #ifdef TUI
2292   add_cmd ("text-user-interface", class_tui,
2293 	   _("TUI is the GDB text based interface.\n\
2294 In TUI mode, GDB can display several text windows showing\n\
2295 the source file, the processor registers, the program disassembly, ..."), &cmdlist);
2296 #endif
2297   add_cmd ("running", class_run, _("Running the program."), &cmdlist);
2298 
2299   /* Define general commands.  */
2300 
2301   add_com ("pwd", class_files, pwd_command, _("\
2302 Print working directory.\n\
2303 This is used for your program as well."));
2304 
2305   c = add_cmd ("cd", class_files, cd_command, _("\
2306 Set working directory to DIR for debugger.\n\
2307 The debugger's current working directory specifies where scripts and other\n\
2308 files that can be loaded by GDB are located.\n\
2309 In order to change the inferior's current working directory, the recommended\n\
2310 way is to use the \"set cwd\" command."), &cmdlist);
2311   set_cmd_completer (c, filename_completer);
2312 
2313   add_com ("echo", class_support, echo_command, _("\
2314 Print a constant string.  Give string as argument.\n\
2315 C escape sequences may be used in the argument.\n\
2316 No newline is added at the end of the argument;\n\
2317 use \"\\n\" if you want a newline to be printed.\n\
2318 Since leading and trailing whitespace are ignored in command arguments,\n\
2319 if you want to print some you must use \"\\\" before leading whitespace\n\
2320 to be printed or after trailing whitespace."));
2321 
2322   add_setshow_enum_cmd ("script-extension", class_support,
2323 			script_ext_enums, &script_ext_mode, _("\
2324 Set mode for script filename extension recognition."), _("\
2325 Show mode for script filename extension recognition."), _("\
2326 off  == no filename extension recognition (all sourced files are GDB scripts)\n\
2327 soft == evaluate script according to filename extension, fallback to GDB script"
2328   "\n\
2329 strict == evaluate script according to filename extension, error if not supported"
2330   ),
2331 			NULL,
2332 			show_script_ext_mode,
2333 			&setlist, &showlist);
2334 
2335   cmd_list_element *quit_cmd
2336     = add_com ("quit", class_support, quit_command, _("\
2337 Exit gdb.\n\
2338 Usage: quit [EXPR]\n\
2339 The optional expression EXPR, if present, is evaluated and the result\n\
2340 used as GDB's exit code.  The default is zero."));
2341   cmd_list_element *help_cmd
2342     = add_com ("help", class_support, help_command,
2343 	       _("Print list of commands."));
2344   set_cmd_completer (help_cmd, command_completer);
2345   add_com_alias ("q", quit_cmd, class_support, 1);
2346   add_com_alias ("h", help_cmd, class_support, 1);
2347 
2348   add_setshow_boolean_cmd ("verbose", class_support, &info_verbose, _("\
2349 Set verbosity."), _("\
2350 Show verbosity."), NULL,
2351 			   set_verbose,
2352 			   show_info_verbose,
2353 			   &setlist, &showlist);
2354 
2355   add_basic_prefix_cmd ("history", class_support, _("\
2356 Generic command for setting command history parameters."),
2357 			&sethistlist, 0, &setlist);
2358   add_show_prefix_cmd ("history", class_support, _("\
2359 Generic command for showing command history parameters."),
2360 		       &showhistlist, 0, &showlist);
2361 
2362   add_setshow_boolean_cmd ("expansion", no_class, &history_expansion_p, _("\
2363 Set history expansion on command input."), _("\
2364 Show history expansion on command input."), _("\
2365 Without an argument, history expansion is enabled."),
2366 			   NULL,
2367 			   show_history_expansion_p,
2368 			   &sethistlist, &showhistlist);
2369 
2370   cmd_list_element *info_cmd
2371     = add_prefix_cmd ("info", class_info, info_command, _("\
2372 Generic command for showing things about the program being debugged."),
2373 		      &infolist, 0, &cmdlist);
2374   add_com_alias ("i", info_cmd, class_info, 1);
2375   add_com_alias ("inf", info_cmd, class_info, 1);
2376 
2377   add_com ("complete", class_obscure, complete_command,
2378 	   _("List the completions for the rest of the line as a command."));
2379 
2380   c = add_show_prefix_cmd ("show", class_info, _("\
2381 Generic command for showing things about the debugger."),
2382 			   &showlist, 0, &cmdlist);
2383   /* Another way to get at the same thing.  */
2384   add_alias_cmd ("set", c, class_info, 0, &infolist);
2385 
2386   cmd_list_element *with_cmd
2387     = add_com ("with", class_vars, with_command, _("\
2388 Temporarily set SETTING to VALUE, run COMMAND, and restore SETTING.\n\
2389 Usage: with SETTING [VALUE] [-- COMMAND]\n\
2390 Usage: w SETTING [VALUE] [-- COMMAND]\n\
2391 With no COMMAND, repeats the last executed command.\n\
2392 \n\
2393 SETTING is any setting you can change with the \"set\" subcommands.\n\
2394 E.g.:\n\
2395   with language pascal -- print obj\n\
2396   with print elements unlimited -- print obj\n\
2397 \n\
2398 You can change multiple settings using nested with, and use\n\
2399 abbreviations for commands and/or values.  E.g.:\n\
2400   w la p -- w p el u -- p obj"));
2401   set_cmd_completer_handle_brkchars (with_cmd, with_command_completer);
2402   add_com_alias ("w", with_cmd, class_vars, 1);
2403 
2404   add_internal_function ("_gdb_setting_str", _("\
2405 $_gdb_setting_str - returns the value of a GDB setting as a string.\n\
2406 Usage: $_gdb_setting_str (setting)\n\
2407 \n\
2408 auto-boolean values are \"off\", \"on\", \"auto\".\n\
2409 boolean values are \"off\", \"on\".\n\
2410 Some integer settings accept an unlimited value, returned\n\
2411 as \"unlimited\"."),
2412 			 gdb_setting_str_internal_fn, NULL);
2413 
2414   add_internal_function ("_gdb_setting", _("\
2415 $_gdb_setting - returns the value of a GDB setting.\n\
2416 Usage: $_gdb_setting (setting)\n\
2417 auto-boolean values are \"off\", \"on\", \"auto\".\n\
2418 boolean values are \"off\", \"on\".\n\
2419 Some integer settings accept an unlimited value, returned\n\
2420 as 0 or -1 depending on the setting."),
2421 			 gdb_setting_internal_fn, NULL);
2422 
2423   add_internal_function ("_gdb_maint_setting_str", _("\
2424 $_gdb_maint_setting_str - returns the value of a GDB maintenance setting as a string.\n\
2425 Usage: $_gdb_maint_setting_str (setting)\n\
2426 \n\
2427 auto-boolean values are \"off\", \"on\", \"auto\".\n\
2428 boolean values are \"off\", \"on\".\n\
2429 Some integer settings accept an unlimited value, returned\n\
2430 as \"unlimited\"."),
2431 			 gdb_maint_setting_str_internal_fn, NULL);
2432 
2433   add_internal_function ("_gdb_maint_setting", _("\
2434 $_gdb_maint_setting - returns the value of a GDB maintenance setting.\n\
2435 Usage: $_gdb_maint_setting (setting)\n\
2436 auto-boolean values are \"off\", \"on\", \"auto\".\n\
2437 boolean values are \"off\", \"on\".\n\
2438 Some integer settings accept an unlimited value, returned\n\
2439 as 0 or -1 depending on the setting."),
2440 			 gdb_maint_setting_internal_fn, NULL);
2441 
2442   add_cmd ("commands", no_set_class, show_commands, _("\
2443 Show the history of commands you typed.\n\
2444 You can supply a command number to start with, or a `+' to start after\n\
2445 the previous command number shown."),
2446 	   &showlist);
2447 
2448   add_cmd ("version", no_set_class, show_version,
2449 	   _("Show what version of GDB this is."), &showlist);
2450 
2451   add_cmd ("configuration", no_set_class, show_configuration,
2452 	   _("Show how GDB was configured at build time."), &showlist);
2453 
2454   add_basic_prefix_cmd ("debug", no_class,
2455 			_("Generic command for setting gdb debugging flags."),
2456 			&setdebuglist, 0, &setlist);
2457 
2458   add_show_prefix_cmd ("debug", no_class,
2459 		       _("Generic command for showing gdb debugging flags."),
2460 		       &showdebuglist, 0, &showlist);
2461 
2462   cmd_list_element *shell_cmd
2463     = add_com ("shell", class_support, shell_command, _("\
2464 Execute the rest of the line as a shell command.\n\
2465 With no arguments, run an inferior shell."));
2466   set_cmd_completer (shell_cmd, filename_completer);
2467 
2468   add_com_alias ("!", shell_cmd, class_support, 0);
2469 
2470   c = add_com ("edit", class_files, edit_command, _("\
2471 Edit specified file or function.\n\
2472 With no argument, edits file containing most recent line listed.\n\
2473 Editing targets can be specified in these ways:\n\
2474   FILE:LINENUM, to edit at that line in that file,\n\
2475   FUNCTION, to edit at the beginning of that function,\n\
2476   FILE:FUNCTION, to distinguish among like-named static functions.\n\
2477   *ADDRESS, to edit at the line containing that address.\n\
2478 Uses EDITOR environment variable contents as editor (or ex as default)."));
2479 
2480   c->completer = location_completer;
2481 
2482   cmd_list_element *pipe_cmd
2483     = add_com ("pipe", class_support, pipe_command, _("\
2484 Send the output of a gdb command to a shell command.\n\
2485 Usage: | [COMMAND] | SHELL_COMMAND\n\
2486 Usage: | -d DELIM COMMAND DELIM SHELL_COMMAND\n\
2487 Usage: pipe [COMMAND] | SHELL_COMMAND\n\
2488 Usage: pipe -d DELIM COMMAND DELIM SHELL_COMMAND\n\
2489 \n\
2490 Executes COMMAND and sends its output to SHELL_COMMAND.\n\
2491 \n\
2492 The -d option indicates to use the string DELIM to separate COMMAND\n\
2493 from SHELL_COMMAND, in alternative to |.  This is useful in\n\
2494 case COMMAND contains a | character.\n\
2495 \n\
2496 With no COMMAND, repeat the last executed command\n\
2497 and send its output to SHELL_COMMAND."));
2498   set_cmd_completer_handle_brkchars (pipe_cmd, pipe_command_completer);
2499   add_com_alias ("|", pipe_cmd, class_support, 0);
2500 
2501   cmd_list_element *list_cmd
2502     = add_com ("list", class_files, list_command, _("\
2503 List specified function or line.\n\
2504 With no argument, lists ten more lines after or around previous listing.\n\
2505 \"list -\" lists the ten lines before a previous ten-line listing.\n\
2506 One argument specifies a line, and ten lines are listed around that line.\n\
2507 Two arguments with comma between specify starting and ending lines to list.\n\
2508 Lines can be specified in these ways:\n\
2509   LINENUM, to list around that line in current file,\n\
2510   FILE:LINENUM, to list around that line in that file,\n\
2511   FUNCTION, to list around beginning of that function,\n\
2512   FILE:FUNCTION, to distinguish among like-named static functions.\n\
2513   *ADDRESS, to list around the line containing that address.\n\
2514 With two args, if one is empty, it stands for ten lines away from\n\
2515 the other arg.\n\
2516 \n\
2517 By default, when a single location is given, display ten lines.\n\
2518 This can be changed using \"set listsize\", and the current value\n\
2519 can be shown using \"show listsize\"."));
2520 
2521   add_com_alias ("l", list_cmd, class_files, 1);
2522 
2523   if (dbx_commands)
2524     add_com_alias ("file", list_cmd, class_files, 1);
2525 
2526   c = add_com ("disassemble", class_vars, disassemble_command, _("\
2527 Disassemble a specified section of memory.\n\
2528 Usage: disassemble[/m|/r|/s] START [, END]\n\
2529 Default is the function surrounding the pc of the selected frame.\n\
2530 \n\
2531 With a /s modifier, source lines are included (if available).\n\
2532 In this mode, the output is displayed in PC address order, and\n\
2533 file names and contents for all relevant source files are displayed.\n\
2534 \n\
2535 With a /m modifier, source lines are included (if available).\n\
2536 This view is \"source centric\": the output is in source line order,\n\
2537 regardless of any optimization that is present.  Only the main source file\n\
2538 is displayed, not those of, e.g., any inlined functions.\n\
2539 This modifier hasn't proved useful in practice and is deprecated\n\
2540 in favor of /s.\n\
2541 \n\
2542 With a /r modifier, raw instructions in hex are included.\n\
2543 \n\
2544 With a single argument, the function surrounding that address is dumped.\n\
2545 Two arguments (separated by a comma) are taken as a range of memory to dump,\n\
2546   in the form of \"start,end\", or \"start,+length\".\n\
2547 \n\
2548 Note that the address is interpreted as an expression, not as a location\n\
2549 like in the \"break\" command.\n\
2550 So, for example, if you want to disassemble function bar in file foo.c\n\
2551 you must type \"disassemble 'foo.c'::bar\" and not \"disassemble foo.c:bar\"."));
2552   set_cmd_completer (c, location_completer);
2553 
2554   c = add_com ("make", class_support, make_command, _("\
2555 Run the ``make'' program using the rest of the line as arguments."));
2556   set_cmd_completer (c, filename_completer);
2557   add_cmd ("user", no_class, show_user, _("\
2558 Show definitions of non-python/scheme user defined commands.\n\
2559 Argument is the name of the user defined command.\n\
2560 With no argument, show definitions of all user defined commands."), &showlist);
2561   add_com ("apropos", class_support, apropos_command, _("\
2562 Search for commands matching a REGEXP.\n\
2563 Usage: apropos [-v] REGEXP\n\
2564 Flag -v indicates to produce a verbose output, showing full documentation\n\
2565 of the matching commands."));
2566 
2567   add_setshow_uinteger_cmd ("max-user-call-depth", no_class,
2568 			   &max_user_call_depth, _("\
2569 Set the max call depth for non-python/scheme user-defined commands."), _("\
2570 Show the max call depth for non-python/scheme user-defined commands."), NULL,
2571 			    NULL,
2572 			    show_max_user_call_depth,
2573 			    &setlist, &showlist);
2574 
2575   add_setshow_boolean_cmd ("trace-commands", no_class, &trace_commands, _("\
2576 Set tracing of GDB CLI commands."), _("\
2577 Show state of GDB CLI command tracing."), _("\
2578 When 'on', each command is displayed as it is executed."),
2579 			   NULL,
2580 			   NULL,
2581 			   &setlist, &showlist);
2582 
2583   const auto alias_opts = make_alias_options_def_group (nullptr);
2584 
2585   static std::string alias_help
2586     = gdb::option::build_help (_("\
2587 Define a new command that is an alias of an existing command.\n\
2588 Usage: alias [-a] [--] ALIAS = COMMAND [DEFAULT-ARGS...]\n\
2589 ALIAS is the name of the alias command to create.\n\
2590 COMMAND is the command being aliased to.\n\
2591 \n\
2592 Options:\n\
2593 %OPTIONS%\n\
2594 \n\
2595 GDB will automatically prepend the provided DEFAULT-ARGS to the list\n\
2596 of arguments explicitly provided when using ALIAS.\n\
2597 Use \"help aliases\" to list all user defined aliases and their default args.\n\
2598 \n\
2599 Examples:\n\
2600 Make \"spe\" an alias of \"set print elements\":\n\
2601   alias spe = set print elements\n\
2602 Make \"elms\" an alias of \"elements\" in the \"set print\" command:\n\
2603   alias -a set print elms = set print elements\n\
2604 Make \"btf\" an alias of \"backtrace -full -past-entry -past-main\" :\n\
2605   alias btf = backtrace -full -past-entry -past-main\n\
2606 Make \"wLapPeu\" an alias of 2 nested \"with\":\n\
2607   alias wLapPeu = with language pascal -- with print elements unlimited --"),
2608 			       alias_opts);
2609 
2610   c = add_com ("alias", class_support, alias_command,
2611 	       alias_help.c_str ());
2612 
2613   set_cmd_completer_handle_brkchars (c, alias_command_completer);
2614 
2615   const char *source_help_text = xstrprintf (_("\
2616 Read commands from a file named FILE.\n\
2617 \n\
2618 Usage: source [-s] [-v] FILE\n\
2619 -s: search for the script in the source search path,\n\
2620     even if FILE contains directories.\n\
2621 -v: each command in FILE is echoed as it is executed.\n\
2622 \n\
2623 Note that the file \"%s\" is read automatically in this way\n\
2624 when GDB is started."), GDBINIT);
2625   c = add_cmd ("source", class_support, source_command,
2626 	       source_help_text, &cmdlist);
2627   set_cmd_completer (c, filename_completer);
2628 }
2629