1 /* List lines of source files for GDB, the GNU debugger.
2 Copyright (C) 1986-2013 Free Software Foundation, Inc.
4 This file is part of GDB.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>. */
20 #include "arch-utils.h"
22 #include "expression.h"
29 #include "gdb_assert.h"
31 #include <sys/types.h>
32 #include "gdb_string.h"
36 #include "gdb_regex.h"
42 #include "filenames.h" /* for DOSish file names */
43 #include "completer.h"
45 #include "readline/readline.h"
50 #define OPEN_MODE (O_RDONLY | O_BINARY)
51 #define FDOPEN_MODE FOPEN_RB
53 /* Prototypes for exported functions. */
55 void _initialize_source (void);
57 /* Prototypes for local functions. */
59 static int get_filename_and_charpos (struct symtab *, char **);
61 static void reverse_search_command (char *, int);
63 static void forward_search_command (char *, int);
65 static void line_info (char *, int);
67 static void source_info (char *, int);
69 /* Path of directories to search for source files.
70 Same format as the PATH environment variable's value. */
74 /* Support for source path substitution commands. */
76 struct substitute_path_rule
80 struct substitute_path_rule *next;
83 static struct substitute_path_rule *substitute_path_rules = NULL;
85 /* Symtab of default file for listing lines of. */
87 static struct symtab *current_source_symtab;
89 /* Default next line to list. */
91 static int current_source_line;
93 static struct program_space *current_source_pspace;
95 /* Default number of lines to print with commands like "list".
96 This is based on guessing how many long (i.e. more than chars_per_line
97 characters) lines there will be. To be completely correct, "list"
98 and friends should be rewritten to count characters and see where
99 things are wrapping, but that would be a fair amount of work. */
101 int lines_to_list = 10;
103 show_lines_to_list (struct ui_file *file, int from_tty,
104 struct cmd_list_element *c, const char *value)
106 fprintf_filtered (file,
107 _("Number of source lines gdb "
108 "will list by default is %s.\n"),
112 /* Line number of last line printed. Default for various commands.
113 current_source_line is usually, but not always, the same as this. */
115 static int last_line_listed;
117 /* First line number listed by last listing command. */
119 static int first_line_listed;
121 /* Saves the name of the last source file visited and a possible error code.
122 Used to prevent repeating annoying "No such file or directories" msgs. */
124 static struct symtab *last_source_visited = NULL;
125 static int last_source_error = 0;
127 /* Return the first line listed by print_source_lines.
128 Used by command interpreters to request listing from
132 get_first_line_listed (void)
134 return first_line_listed;
137 /* Return the default number of lines to print with commands like the
138 cli "list". The caller of print_source_lines must use this to
139 calculate the end line and use it in the call to print_source_lines
140 as it does not automatically use this value. */
143 get_lines_to_list (void)
145 return lines_to_list;
148 /* Return the current source file for listing and next line to list.
149 NOTE: The returned sal pc and end fields are not valid. */
151 struct symtab_and_line
152 get_current_source_symtab_and_line (void)
154 struct symtab_and_line cursal = { 0 };
156 cursal.pspace = current_source_pspace;
157 cursal.symtab = current_source_symtab;
158 cursal.line = current_source_line;
165 /* If the current source file for listing is not set, try and get a default.
166 Usually called before get_current_source_symtab_and_line() is called.
167 It may err out if a default cannot be determined.
168 We must be cautious about where it is called, as it can recurse as the
169 process of determining a new default may call the caller!
170 Use get_current_source_symtab_and_line only to get whatever
171 we have without erroring out or trying to get a default. */
174 set_default_source_symtab_and_line (void)
176 if (!have_full_symbols () && !have_partial_symbols ())
177 error (_("No symbol table is loaded. Use the \"file\" command."));
179 /* Pull in a current source symtab if necessary. */
180 if (current_source_symtab == 0)
181 select_source_symtab (0);
184 /* Return the current default file for listing and next line to list
185 (the returned sal pc and end fields are not valid.)
186 and set the current default to whatever is in SAL.
187 NOTE: The returned sal pc and end fields are not valid. */
189 struct symtab_and_line
190 set_current_source_symtab_and_line (const struct symtab_and_line *sal)
192 struct symtab_and_line cursal = { 0 };
194 cursal.pspace = current_source_pspace;
195 cursal.symtab = current_source_symtab;
196 cursal.line = current_source_line;
200 current_source_pspace = sal->pspace;
201 current_source_symtab = sal->symtab;
202 current_source_line = sal->line;
207 /* Reset any information stored about a default file and line to print. */
210 clear_current_source_symtab_and_line (void)
212 current_source_symtab = 0;
213 current_source_line = 0;
216 /* Set the source file default for the "list" command to be S.
218 If S is NULL, and we don't have a default, find one. This
219 should only be called when the user actually tries to use the
220 default, since we produce an error if we can't find a reasonable
221 default. Also, since this can cause symbols to be read, doing it
222 before we need to would make things slower than necessary. */
225 select_source_symtab (struct symtab *s)
227 struct symtabs_and_lines sals;
228 struct symtab_and_line sal;
233 current_source_symtab = s;
234 current_source_line = 1;
235 current_source_pspace = SYMTAB_PSPACE (s);
239 if (current_source_symtab)
242 /* Make the default place to list be the function `main'
244 if (lookup_symbol (main_name (), 0, VAR_DOMAIN, 0))
246 sals = decode_line_with_current_source (main_name (),
247 DECODE_LINE_FUNFIRSTLINE);
250 current_source_pspace = sal.pspace;
251 current_source_symtab = sal.symtab;
252 current_source_line = max (sal.line - (lines_to_list - 1), 1);
253 if (current_source_symtab)
257 /* Alright; find the last file in the symtab list (ignoring .h's
258 and namespace symtabs). */
260 current_source_line = 1;
264 for (s = ofp->symtabs; s; s = s->next)
266 const char *name = s->filename;
267 int len = strlen (name);
269 if (!(len > 2 && (strcmp (&name[len - 2], ".h") == 0
270 || strcmp (name, "<<C++-namespaces>>") == 0)))
272 current_source_pspace = current_program_space;
273 current_source_symtab = s;
278 if (current_source_symtab)
284 s = ofp->sf->qf->find_last_source_symtab (ofp);
286 current_source_symtab = s;
288 if (current_source_symtab)
291 error (_("Can't find a default source file"));
294 /* Handler for "set directories path-list" command.
295 "set dir mumble" doesn't prepend paths, it resets the entire
296 path list. The theory is that set(show(dir)) should be a no-op. */
299 set_directories_command (char *args, int from_tty, struct cmd_list_element *c)
301 /* This is the value that was set.
302 It needs to be processed to maintain $cdir:$cwd and remove dups. */
303 char *set_path = source_path;
305 /* We preserve the invariant that $cdir:$cwd begins life at the end of
306 the list by calling init_source_path. If they appear earlier in
307 SET_PATH then mod_path will move them appropriately.
308 mod_path will also remove duplicates. */
310 if (*set_path != '\0')
311 mod_path (set_path, &source_path);
316 /* Print the list of source directories.
317 This is used by the "ld" command, so it has the signature of a command
321 show_directories_1 (char *ignore, int from_tty)
323 puts_filtered ("Source directories searched: ");
324 puts_filtered (source_path);
325 puts_filtered ("\n");
328 /* Handler for "show directories" command. */
331 show_directories_command (struct ui_file *file, int from_tty,
332 struct cmd_list_element *c, const char *value)
334 show_directories_1 (NULL, from_tty);
337 /* Forget line positions and file names for the symtabs in a
338 particular objfile. */
341 forget_cached_source_info_for_objfile (struct objfile *objfile)
345 ALL_OBJFILE_SYMTABS (objfile, s)
347 if (s->line_charpos != NULL)
349 xfree (s->line_charpos);
350 s->line_charpos = NULL;
352 if (s->fullname != NULL)
360 objfile->sf->qf->forget_cached_source_info (objfile);
363 /* Forget what we learned about line positions in source files, and
364 which directories contain them; must check again now since files
365 may be found in a different directory now. */
368 forget_cached_source_info (void)
370 struct program_space *pspace;
371 struct objfile *objfile;
374 ALL_PSPACE_OBJFILES (pspace, objfile)
376 forget_cached_source_info_for_objfile (objfile);
379 last_source_visited = NULL;
383 init_source_path (void)
387 xsnprintf (buf, sizeof (buf), "$cdir%c$cwd", DIRNAME_SEPARATOR);
388 source_path = xstrdup (buf);
389 forget_cached_source_info ();
392 /* Add zero or more directories to the front of the source path. */
395 directory_command (char *dirname, int from_tty)
398 /* FIXME, this goes to "delete dir"... */
401 if (!from_tty || query (_("Reinitialize source path to empty? ")))
409 mod_path (dirname, &source_path);
410 forget_cached_source_info ();
413 show_directories_1 ((char *) 0, from_tty);
416 /* Add a path given with the -d command line switch.
417 This will not be quoted so we must not treat spaces as separators. */
420 directory_switch (char *dirname, int from_tty)
422 add_path (dirname, &source_path, 0);
425 /* Add zero or more directories to the front of an arbitrary path. */
428 mod_path (char *dirname, char **which_path)
430 add_path (dirname, which_path, 1);
433 /* Workhorse of mod_path. Takes an extra argument to determine
434 if dirname should be parsed for separators that indicate multiple
435 directories. This allows for interfaces that pre-parse the dirname
436 and allow specification of traditional separator characters such
440 add_path (char *dirname, char **which_path, int parse_separators)
442 char *old = *which_path;
444 VEC (char_ptr) *dir_vec = NULL;
445 struct cleanup *back_to;
452 if (parse_separators)
454 char **argv, **argvp;
456 /* This will properly parse the space and tab separators
457 and any quotes that may exist. */
458 argv = gdb_buildargv (dirname);
460 for (argvp = argv; *argvp; argvp++)
461 dirnames_to_char_ptr_vec_append (&dir_vec, *argvp);
466 VEC_safe_push (char_ptr, dir_vec, xstrdup (dirname));
467 back_to = make_cleanup_free_char_ptr_vec (dir_vec);
469 for (ix = 0; VEC_iterate (char_ptr, dir_vec, ix, name); ++ix)
474 /* Spaces and tabs will have been removed by buildargv().
475 NAME is the start of the directory.
476 P is the '\0' following the end. */
477 p = name + strlen (name);
479 while (!(IS_DIR_SEPARATOR (*name) && p <= name + 1) /* "/" */
480 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
481 /* On MS-DOS and MS-Windows, h:\ is different from h: */
482 && !(p == name + 3 && name[1] == ':') /* "d:/" */
484 && IS_DIR_SEPARATOR (p[-1]))
485 /* Sigh. "foo/" => "foo" */
489 while (p > name && p[-1] == '.')
493 /* "." => getwd (). */
494 name = current_directory;
497 else if (p > name + 1 && IS_DIR_SEPARATOR (p[-2]))
507 /* "...foo/." => "...foo". */
518 name = tilde_expand (name);
519 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
520 else if (IS_ABSOLUTE_PATH (name) && p == name + 2) /* "d:" => "d:." */
521 name = concat (name, ".", (char *)NULL);
523 else if (!IS_ABSOLUTE_PATH (name) && name[0] != '$')
524 name = concat (current_directory, SLASH_STRING, name, (char *)NULL);
526 name = savestring (name, p - name);
527 make_cleanup (xfree, name);
529 /* Unless it's a variable, check existence. */
532 /* These are warnings, not errors, since we don't want a
533 non-existent directory in a .gdbinit file to stop processing
534 of the .gdbinit file.
536 Whether they get added to the path is more debatable. Current
537 answer is yes, in case the user wants to go make the directory
538 or whatever. If the directory continues to not exist/not be
539 a directory/etc, then having them in the path should be
541 if (stat (name, &st) < 0)
543 int save_errno = errno;
545 fprintf_unfiltered (gdb_stderr, "Warning: ");
546 print_sys_errmsg (name, save_errno);
548 else if ((st.st_mode & S_IFMT) != S_IFDIR)
549 warning (_("%s is not a directory."), name);
554 unsigned int len = strlen (name);
558 /* FIXME: we should use realpath() or its work-alike
559 before comparing. Then all the code above which
560 removes excess slashes and dots could simply go away. */
561 if (!filename_cmp (p, name))
563 /* Found it in the search path, remove old copy. */
565 p--; /* Back over leading separator. */
566 if (prefix > p - *which_path)
567 goto skip_dup; /* Same dir twice in one cmd. */
568 memmove (p, &p[len + 1], strlen (&p[len + 1]) + 1); /* Copy from next \0 or : */
571 tinybuf[0] = DIRNAME_SEPARATOR;
574 /* If we have already tacked on a name(s) in this command,
575 be sure they stay on the front as we tack on some
583 temp = concat (old, tinybuf, name, (char *)NULL);
585 *which_path = concat (temp, "", &old[prefix], (char *) NULL);
586 prefix = strlen (temp);
591 *which_path = concat (name, (old[0] ? tinybuf : old),
593 prefix = strlen (name);
602 do_cleanups (back_to);
607 source_info (char *ignore, int from_tty)
609 struct symtab *s = current_source_symtab;
613 printf_filtered (_("No current source file.\n"));
616 printf_filtered (_("Current source file is %s\n"), s->filename);
618 printf_filtered (_("Compilation directory is %s\n"), s->dirname);
620 printf_filtered (_("Located in %s\n"), s->fullname);
622 printf_filtered (_("Contains %d line%s.\n"), s->nlines,
623 s->nlines == 1 ? "" : "s");
625 printf_filtered (_("Source language is %s.\n"), language_str (s->language));
626 printf_filtered (_("Compiled with %s debugging format.\n"), s->debugformat);
627 printf_filtered (_("%s preprocessor macro info.\n"),
628 s->macro_table ? "Includes" : "Does not include");
632 /* Return True if the file NAME exists and is a regular file. */
634 is_regular_file (const char *name)
637 const int status = stat (name, &st);
639 /* Stat should never fail except when the file does not exist.
640 If stat fails, analyze the source of error and return True
641 unless the file does not exist, to avoid returning false results
642 on obscure systems where stat does not work as expected. */
645 return (errno != ENOENT);
647 return S_ISREG (st.st_mode);
650 /* Open a file named STRING, searching path PATH (dir names sep by some char)
651 using mode MODE in the calls to open. You cannot use this function to
652 create files (O_CREAT).
654 OPTS specifies the function behaviour in specific cases.
656 If OPF_TRY_CWD_FIRST, try to open ./STRING before searching PATH.
657 (ie pretend the first element of PATH is "."). This also indicates
658 that a slash in STRING disables searching of the path (this is
659 so that "exec-file ./foo" or "symbol-file ./foo" insures that you
660 get that particular version of foo or an error message).
662 If OPTS has OPF_SEARCH_IN_PATH set, absolute names will also be
663 searched in path (we usually want this for source files but not for
666 If FILENAME_OPENED is non-null, set it to a newly allocated string naming
667 the actual file opened (this string will always start with a "/"). We
668 have to take special pains to avoid doubling the "/" between the directory
669 and the file, sigh! Emacs gets confuzzed by this when we print the
672 If a file is found, return the descriptor.
673 Otherwise, return -1, with errno set for the last name we tried to open. */
675 /* >>>> This should only allow files of certain types,
676 >>>> eg executable, non-directory. */
678 openp (const char *path, int opts, const char *string,
679 int mode, char **filename_opened)
684 VEC (char_ptr) *dir_vec;
685 struct cleanup *back_to;
689 /* The open syscall MODE parameter is not specified. */
690 gdb_assert ((mode & O_CREAT) == 0);
691 gdb_assert (string != NULL);
693 /* A file with an empty name cannot possibly exist. Report a failure
694 without further checking.
696 This is an optimization which also defends us against buggy
697 implementations of the "stat" function. For instance, we have
698 noticed that a MinGW debugger built on Windows XP 32bits crashes
699 when the debugger is started with an empty argument. */
700 if (string[0] == '\0')
711 if ((opts & OPF_TRY_CWD_FIRST) || IS_ABSOLUTE_PATH (string))
715 if (is_regular_file (string))
717 filename = alloca (strlen (string) + 1);
718 strcpy (filename, string);
719 fd = open (filename, mode);
729 if (!(opts & OPF_SEARCH_IN_PATH))
730 for (i = 0; string[i]; i++)
731 if (IS_DIR_SEPARATOR (string[i]))
735 /* For dos paths, d:/foo -> /foo, and d:foo -> foo. */
736 if (HAS_DRIVE_SPEC (string))
737 string = STRIP_DRIVE_SPEC (string);
739 /* /foo => foo, to avoid multiple slashes that Emacs doesn't like. */
740 while (IS_DIR_SEPARATOR(string[0]))
744 while (string[0] == '.' && IS_DIR_SEPARATOR (string[1]))
747 alloclen = strlen (path) + strlen (string) + 2;
748 filename = alloca (alloclen);
751 dir_vec = dirnames_to_char_ptr_vec (path);
752 back_to = make_cleanup_free_char_ptr_vec (dir_vec);
754 for (ix = 0; VEC_iterate (char_ptr, dir_vec, ix, dir); ++ix)
756 size_t len = strlen (dir);
758 if (strcmp (dir, "$cwd") == 0)
760 /* Name is $cwd -- insert current directory name instead. */
763 /* First, realloc the filename buffer if too short. */
764 len = strlen (current_directory);
765 newlen = len + strlen (string) + 2;
766 if (newlen > alloclen)
769 filename = alloca (alloclen);
771 strcpy (filename, current_directory);
773 else if (strchr(dir, '~'))
775 /* See whether we need to expand the tilde. */
777 char *tilde_expanded;
779 tilde_expanded = tilde_expand (dir);
781 /* First, realloc the filename buffer if too short. */
782 len = strlen (tilde_expanded);
783 newlen = len + strlen (string) + 2;
784 if (newlen > alloclen)
787 filename = alloca (alloclen);
789 strcpy (filename, tilde_expanded);
790 xfree (tilde_expanded);
794 /* Normal file name in path -- just use it. */
795 strcpy (filename, dir);
797 /* Don't search $cdir. It's also a magic path like $cwd, but we
798 don't have enough information to expand it. The user *could*
799 have an actual directory named '$cdir' but handling that would
800 be confusing, it would mean different things in different
801 contexts. If the user really has '$cdir' one can use './$cdir'.
802 We can get $cdir when loading scripts. When loading source files
803 $cdir must have already been expanded to the correct value. */
804 if (strcmp (dir, "$cdir") == 0)
808 /* Remove trailing slashes. */
809 while (len > 0 && IS_DIR_SEPARATOR (filename[len - 1]))
812 strcat (filename + len, SLASH_STRING);
813 strcat (filename, string);
815 if (is_regular_file (filename))
817 fd = open (filename, mode);
823 do_cleanups (back_to);
828 /* If a file was opened, canonicalize its filename. */
830 *filename_opened = NULL;
831 else if (IS_ABSOLUTE_PATH (filename))
832 *filename_opened = gdb_realpath (filename);
835 /* Beware the // my son, the Emacs barfs, the botch that catch... */
837 char *f = concat (current_directory,
838 IS_DIR_SEPARATOR (current_directory[strlen (current_directory) - 1])
840 filename, (char *)NULL);
842 *filename_opened = gdb_realpath (f);
851 /* This is essentially a convenience, for clients that want the behaviour
852 of openp, using source_path, but that really don't want the file to be
853 opened but want instead just to know what the full pathname is (as
854 qualified against source_path).
856 The current working directory is searched first.
858 If the file was found, this function returns 1, and FULL_PATHNAME is
859 set to the fully-qualified pathname.
861 Else, this functions returns 0, and FULL_PATHNAME is set to NULL. */
863 source_full_path_of (const char *filename, char **full_pathname)
867 fd = openp (source_path, OPF_TRY_CWD_FIRST | OPF_SEARCH_IN_PATH, filename,
868 O_RDONLY, full_pathname);
871 *full_pathname = NULL;
879 /* Return non-zero if RULE matches PATH, that is if the rule can be
883 substitute_path_rule_matches (const struct substitute_path_rule *rule,
886 const int from_len = strlen (rule->from);
887 const int path_len = strlen (path);
890 if (path_len < from_len)
893 /* The substitution rules are anchored at the start of the path,
894 so the path should start with rule->from. There is no filename
895 comparison routine, so we need to extract the first FROM_LEN
896 characters from PATH first and use that to do the comparison. */
898 path_start = alloca (from_len + 1);
899 strncpy (path_start, path, from_len);
900 path_start[from_len] = '\0';
902 if (FILENAME_CMP (path_start, rule->from) != 0)
905 /* Make sure that the region in the path that matches the substitution
906 rule is immediately followed by a directory separator (or the end of
907 string character). */
909 if (path[from_len] != '\0' && !IS_DIR_SEPARATOR (path[from_len]))
915 /* Find the substitute-path rule that applies to PATH and return it.
916 Return NULL if no rule applies. */
918 static struct substitute_path_rule *
919 get_substitute_path_rule (const char *path)
921 struct substitute_path_rule *rule = substitute_path_rules;
923 while (rule != NULL && !substitute_path_rule_matches (rule, path))
929 /* If the user specified a source path substitution rule that applies
930 to PATH, then apply it and return the new path. This new path must
931 be deallocated afterwards.
933 Return NULL if no substitution rule was specified by the user,
934 or if no rule applied to the given PATH. */
937 rewrite_source_path (const char *path)
939 const struct substitute_path_rule *rule = get_substitute_path_rule (path);
946 from_len = strlen (rule->from);
948 /* Compute the rewritten path and return it. */
951 (char *) xmalloc (strlen (path) + 1 + strlen (rule->to) - from_len);
952 strcpy (new_path, rule->to);
953 strcat (new_path, path + from_len);
959 find_and_open_source (const char *filename,
963 char *path = source_path;
967 /* Quick way out if we already know its full name. */
971 /* The user may have requested that source paths be rewritten
972 according to substitution rules he provided. If a substitution
973 rule applies to this path, then apply it. */
974 char *rewritten_fullname = rewrite_source_path (*fullname);
976 if (rewritten_fullname != NULL)
979 *fullname = rewritten_fullname;
982 result = open (*fullname, OPEN_MODE);
985 char *lpath = gdb_realpath (*fullname);
992 /* Didn't work -- free old one, try again. */
999 /* If necessary, rewrite the compilation directory name according
1000 to the source path substitution rules specified by the user. */
1002 char *rewritten_dirname = rewrite_source_path (dirname);
1004 if (rewritten_dirname != NULL)
1006 make_cleanup (xfree, rewritten_dirname);
1007 dirname = rewritten_dirname;
1010 /* Replace a path entry of $cdir with the compilation directory
1013 /* We cast strstr's result in case an ANSIhole has made it const,
1014 which produces a "required warning" when assigned to a nonconst. */
1015 p = (char *) strstr (source_path, "$cdir");
1016 if (p && (p == path || p[-1] == DIRNAME_SEPARATOR)
1017 && (p[cdir_len] == DIRNAME_SEPARATOR || p[cdir_len] == '\0'))
1022 alloca (strlen (source_path) + 1 + strlen (dirname) + 1);
1023 len = p - source_path;
1024 strncpy (path, source_path, len); /* Before $cdir */
1025 strcpy (path + len, dirname); /* new stuff */
1026 strcat (path + len, source_path + len + cdir_len); /* After
1031 if (IS_ABSOLUTE_PATH (filename))
1033 /* If filename is absolute path, try the source path
1034 substitution on it. */
1035 char *rewritten_filename = rewrite_source_path (filename);
1037 if (rewritten_filename != NULL)
1039 make_cleanup (xfree, rewritten_filename);
1040 filename = rewritten_filename;
1044 result = openp (path, OPF_SEARCH_IN_PATH, filename, OPEN_MODE, fullname);
1047 /* Didn't work. Try using just the basename. */
1048 p = lbasename (filename);
1050 result = openp (path, OPF_SEARCH_IN_PATH, p, OPEN_MODE, fullname);
1056 /* Open a source file given a symtab S. Returns a file descriptor or
1057 negative number for error.
1059 This function is a convience function to find_and_open_source. */
1062 open_source_file (struct symtab *s)
1067 return find_and_open_source (s->filename, s->dirname, &s->fullname);
1070 /* Finds the fullname that a symtab represents.
1072 This functions finds the fullname and saves it in s->fullname.
1073 It will also return the value.
1075 If this function fails to find the file that this symtab represents,
1076 the expected fullname is used. Therefore the files does not have to
1080 symtab_to_fullname (struct symtab *s)
1082 /* Use cached copy if we have it.
1083 We rely on forget_cached_source_info being called appropriately
1084 to handle cases like the file being moved. */
1085 if (s->fullname == NULL)
1087 int fd = find_and_open_source (s->filename, s->dirname, &s->fullname);
1094 struct cleanup *back_to;
1096 /* rewrite_source_path would be applied by find_and_open_source, we
1097 should report the pathname where GDB tried to find the file. */
1099 if (s->dirname == NULL || IS_ABSOLUTE_PATH (s->filename))
1100 fullname = xstrdup (s->filename);
1102 fullname = concat (s->dirname, SLASH_STRING, s->filename, NULL);
1104 back_to = make_cleanup (xfree, fullname);
1105 s->fullname = rewrite_source_path (fullname);
1106 if (s->fullname == NULL)
1107 s->fullname = xstrdup (fullname);
1108 do_cleanups (back_to);
1115 /* Create and initialize the table S->line_charpos that records
1116 the positions of the lines in the source file, which is assumed
1117 to be open on descriptor DESC.
1118 All set S->nlines to the number of such lines. */
1121 find_source_lines (struct symtab *s, int desc)
1124 char *data, *p, *end;
1126 int lines_allocated = 1000;
1132 line_charpos = (int *) xmalloc (lines_allocated * sizeof (int));
1133 if (fstat (desc, &st) < 0)
1134 perror_with_name (s->filename);
1136 if (s->objfile && s->objfile->obfd)
1137 mtime = s->objfile->mtime;
1139 mtime = exec_bfd_mtime;
1141 if (mtime && mtime < st.st_mtime)
1142 warning (_("Source file is more recent than executable."));
1145 struct cleanup *old_cleanups;
1147 /* st_size might be a large type, but we only support source files whose
1148 size fits in an int. */
1149 size = (int) st.st_size;
1151 /* Use malloc, not alloca, because this may be pretty large, and we may
1152 run into various kinds of limits on stack size. */
1153 data = (char *) xmalloc (size);
1154 old_cleanups = make_cleanup (xfree, data);
1156 /* Reassign `size' to result of read for systems where \r\n -> \n. */
1157 size = myread (desc, data, size);
1159 perror_with_name (s->filename);
1162 line_charpos[0] = 0;
1167 /* A newline at the end does not start a new line. */
1170 if (nlines == lines_allocated)
1172 lines_allocated *= 2;
1174 (int *) xrealloc ((char *) line_charpos,
1175 sizeof (int) * lines_allocated);
1177 line_charpos[nlines++] = p - data;
1180 do_cleanups (old_cleanups);
1185 (int *) xrealloc ((char *) line_charpos, nlines * sizeof (int));
1191 /* Get full pathname and line number positions for a symtab.
1192 Return nonzero if line numbers may have changed.
1193 Set *FULLNAME to actual name of the file as found by `openp',
1194 or to 0 if the file is not found. */
1197 get_filename_and_charpos (struct symtab *s, char **fullname)
1199 int desc, linenums_changed = 0;
1200 struct cleanup *cleanups;
1202 desc = open_source_file (s);
1209 cleanups = make_cleanup_close (desc);
1211 *fullname = s->fullname;
1212 if (s->line_charpos == 0)
1213 linenums_changed = 1;
1214 if (linenums_changed)
1215 find_source_lines (s, desc);
1216 do_cleanups (cleanups);
1217 return linenums_changed;
1220 /* Print text describing the full name of the source file S
1221 and the line number LINE and its corresponding character position.
1222 The text starts with two Ctrl-z so that the Emacs-GDB interface
1225 MID_STATEMENT is nonzero if the PC is not at the beginning of that line.
1227 Return 1 if successful, 0 if could not find the file. */
1230 identify_source_line (struct symtab *s, int line, int mid_statement,
1233 if (s->line_charpos == 0)
1234 get_filename_and_charpos (s, (char **) NULL);
1235 if (s->fullname == 0)
1237 if (line > s->nlines)
1238 /* Don't index off the end of the line_charpos array. */
1240 annotate_source (s->fullname, line, s->line_charpos[line - 1],
1241 mid_statement, get_objfile_arch (s->objfile), pc);
1243 current_source_line = line;
1244 first_line_listed = line;
1245 last_line_listed = line;
1246 current_source_symtab = s;
1251 /* Print source lines from the file of symtab S,
1252 starting with line number LINE and stopping before line number STOPLINE. */
1255 print_source_lines_base (struct symtab *s, int line, int stopline,
1256 enum print_source_lines_flags flags)
1262 int nlines = stopline - line;
1263 struct cleanup *cleanup;
1264 struct ui_out *uiout = current_uiout;
1266 /* Regardless of whether we can open the file, set current_source_symtab. */
1267 current_source_symtab = s;
1268 current_source_line = line;
1269 first_line_listed = line;
1271 /* If printing of source lines is disabled, just print file and line
1273 if (ui_out_test_flags (uiout, ui_source_list))
1275 /* Only prints "No such file or directory" once. */
1276 if ((s != last_source_visited) || (!last_source_error))
1278 last_source_visited = s;
1279 desc = open_source_file (s);
1283 desc = last_source_error;
1284 flags |= PRINT_SOURCE_LINES_NOERROR;
1289 desc = last_source_error;
1290 flags |= PRINT_SOURCE_LINES_NOERROR;
1294 if (desc < 0 || noprint)
1296 last_source_error = desc;
1298 if (!(flags & PRINT_SOURCE_LINES_NOERROR))
1300 int len = strlen (s->filename) + 100;
1301 char *name = alloca (len);
1303 xsnprintf (name, len, "%d\t%s", line, s->filename);
1304 print_sys_errmsg (name, errno);
1308 ui_out_field_int (uiout, "line", line);
1309 ui_out_text (uiout, "\tin ");
1310 ui_out_field_string (uiout, "file", s->filename);
1311 if (ui_out_is_mi_like_p (uiout))
1313 const char *fullname = symtab_to_fullname (s);
1315 ui_out_field_string (uiout, "fullname", fullname);
1317 ui_out_text (uiout, "\n");
1323 last_source_error = 0;
1325 if (s->line_charpos == 0)
1326 find_source_lines (s, desc);
1328 if (line < 1 || line > s->nlines)
1331 error (_("Line number %d out of range; %s has %d lines."),
1332 line, s->filename, s->nlines);
1335 if (lseek (desc, s->line_charpos[line - 1], 0) < 0)
1338 perror_with_name (s->filename);
1341 stream = fdopen (desc, FDOPEN_MODE);
1343 cleanup = make_cleanup_fclose (stream);
1345 while (nlines-- > 0)
1352 last_line_listed = current_source_line;
1353 if (flags & PRINT_SOURCE_LINES_FILENAME)
1355 ui_out_text (uiout, s->filename);
1356 ui_out_text (uiout, ":");
1358 xsnprintf (buf, sizeof (buf), "%d\t", current_source_line++);
1359 ui_out_text (uiout, buf);
1362 if (c < 040 && c != '\t' && c != '\n' && c != '\r')
1364 xsnprintf (buf, sizeof (buf), "^%c", c + 0100);
1365 ui_out_text (uiout, buf);
1368 ui_out_text (uiout, "^?");
1371 /* Skip a \r character, but only before a \n. */
1372 int c1 = fgetc (stream);
1375 printf_filtered ("^%c", c + 0100);
1377 ungetc (c1, stream);
1381 xsnprintf (buf, sizeof (buf), "%c", c);
1382 ui_out_text (uiout, buf);
1385 while (c != '\n' && (c = fgetc (stream)) >= 0);
1388 do_cleanups (cleanup);
1391 /* Show source lines from the file of symtab S, starting with line
1392 number LINE and stopping before line number STOPLINE. If this is
1393 not the command line version, then the source is shown in the source
1394 window otherwise it is simply printed. */
1397 print_source_lines (struct symtab *s, int line, int stopline,
1398 enum print_source_lines_flags flags)
1400 print_source_lines_base (s, line, stopline, flags);
1403 /* Print info on range of pc's in a specified line. */
1406 line_info (char *arg, int from_tty)
1408 struct symtabs_and_lines sals;
1409 struct symtab_and_line sal;
1410 CORE_ADDR start_pc, end_pc;
1412 struct cleanup *cleanups;
1414 init_sal (&sal); /* initialize to zeroes */
1418 sal.symtab = current_source_symtab;
1419 sal.pspace = current_program_space;
1420 sal.line = last_line_listed;
1422 sals.sals = (struct symtab_and_line *)
1423 xmalloc (sizeof (struct symtab_and_line));
1428 sals = decode_line_with_last_displayed (arg, DECODE_LINE_LIST_MODE);
1433 cleanups = make_cleanup (xfree, sals.sals);
1435 /* C++ More than one line may have been specified, as when the user
1436 specifies an overloaded function name. Print info on them all. */
1437 for (i = 0; i < sals.nelts; i++)
1440 if (sal.pspace != current_program_space)
1443 if (sal.symtab == 0)
1445 struct gdbarch *gdbarch = get_current_arch ();
1447 printf_filtered (_("No line number information available"));
1450 /* This is useful for "info line *0x7f34". If we can't tell the
1451 user about a source line, at least let them have the symbolic
1453 printf_filtered (" for address ");
1455 print_address (gdbarch, sal.pc, gdb_stdout);
1458 printf_filtered (".");
1459 printf_filtered ("\n");
1461 else if (sal.line > 0
1462 && find_line_pc_range (sal, &start_pc, &end_pc))
1464 struct gdbarch *gdbarch = get_objfile_arch (sal.symtab->objfile);
1466 if (start_pc == end_pc)
1468 printf_filtered ("Line %d of \"%s\"",
1469 sal.line, sal.symtab->filename);
1471 printf_filtered (" is at address ");
1472 print_address (gdbarch, start_pc, gdb_stdout);
1474 printf_filtered (" but contains no code.\n");
1478 printf_filtered ("Line %d of \"%s\"",
1479 sal.line, sal.symtab->filename);
1481 printf_filtered (" starts at address ");
1482 print_address (gdbarch, start_pc, gdb_stdout);
1484 printf_filtered (" and ends at ");
1485 print_address (gdbarch, end_pc, gdb_stdout);
1486 printf_filtered (".\n");
1489 /* x/i should display this line's code. */
1490 set_next_address (gdbarch, start_pc);
1492 /* Repeating "info line" should do the following line. */
1493 last_line_listed = sal.line + 1;
1495 /* If this is the only line, show the source code. If it could
1496 not find the file, don't do anything special. */
1497 if (annotation_level && sals.nelts == 1)
1498 identify_source_line (sal.symtab, sal.line, 0, start_pc);
1501 /* Is there any case in which we get here, and have an address
1502 which the user would want to see? If we have debugging symbols
1503 and no line numbers? */
1504 printf_filtered (_("Line number %d is out of range for \"%s\".\n"),
1505 sal.line, sal.symtab->filename);
1507 do_cleanups (cleanups);
1510 /* Commands to search the source file for a regexp. */
1513 forward_search_command (char *regex, int from_tty)
1520 struct cleanup *cleanups;
1522 line = last_line_listed + 1;
1524 msg = (char *) re_comp (regex);
1526 error (("%s"), msg);
1528 if (current_source_symtab == 0)
1529 select_source_symtab (0);
1531 desc = open_source_file (current_source_symtab);
1533 perror_with_name (current_source_symtab->filename);
1534 cleanups = make_cleanup_close (desc);
1536 if (current_source_symtab->line_charpos == 0)
1537 find_source_lines (current_source_symtab, desc);
1539 if (line < 1 || line > current_source_symtab->nlines)
1540 error (_("Expression not found"));
1542 if (lseek (desc, current_source_symtab->line_charpos[line - 1], 0) < 0)
1543 perror_with_name (current_source_symtab->filename);
1545 discard_cleanups (cleanups);
1546 stream = fdopen (desc, FDOPEN_MODE);
1548 cleanups = make_cleanup_fclose (stream);
1551 static char *buf = NULL;
1553 int cursize, newsize;
1556 buf = xmalloc (cursize);
1565 if (p - buf == cursize)
1567 newsize = cursize + cursize / 2;
1568 buf = xrealloc (buf, newsize);
1573 while (c != '\n' && (c = getc (stream)) >= 0);
1575 /* Remove the \r, if any, at the end of the line, otherwise
1576 regular expressions that end with $ or \n won't work. */
1577 if (p - buf > 1 && p[-2] == '\r')
1583 /* We now have a source line in buf, null terminate and match. */
1585 if (re_exec (buf) > 0)
1588 do_cleanups (cleanups);
1589 print_source_lines (current_source_symtab, line, line + 1, 0);
1590 set_internalvar_integer (lookup_internalvar ("_"), line);
1591 current_source_line = max (line - lines_to_list / 2, 1);
1597 printf_filtered (_("Expression not found\n"));
1598 do_cleanups (cleanups);
1602 reverse_search_command (char *regex, int from_tty)
1609 struct cleanup *cleanups;
1611 line = last_line_listed - 1;
1613 msg = (char *) re_comp (regex);
1615 error (("%s"), msg);
1617 if (current_source_symtab == 0)
1618 select_source_symtab (0);
1620 desc = open_source_file (current_source_symtab);
1622 perror_with_name (current_source_symtab->filename);
1623 cleanups = make_cleanup_close (desc);
1625 if (current_source_symtab->line_charpos == 0)
1626 find_source_lines (current_source_symtab, desc);
1628 if (line < 1 || line > current_source_symtab->nlines)
1629 error (_("Expression not found"));
1631 if (lseek (desc, current_source_symtab->line_charpos[line - 1], 0) < 0)
1632 perror_with_name (current_source_symtab->filename);
1634 discard_cleanups (cleanups);
1635 stream = fdopen (desc, FDOPEN_MODE);
1637 cleanups = make_cleanup_fclose (stream);
1640 /* FIXME!!! We walk right off the end of buf if we get a long line!!! */
1641 char buf[4096]; /* Should be reasonable??? */
1651 while (c != '\n' && (c = getc (stream)) >= 0);
1653 /* Remove the \r, if any, at the end of the line, otherwise
1654 regular expressions that end with $ or \n won't work. */
1655 if (p - buf > 1 && p[-2] == '\r')
1661 /* We now have a source line in buf; null terminate and match. */
1663 if (re_exec (buf) > 0)
1666 do_cleanups (cleanups);
1667 print_source_lines (current_source_symtab, line, line + 1, 0);
1668 set_internalvar_integer (lookup_internalvar ("_"), line);
1669 current_source_line = max (line - lines_to_list / 2, 1);
1673 if (fseek (stream, current_source_symtab->line_charpos[line - 1], 0) < 0)
1675 do_cleanups (cleanups);
1676 perror_with_name (current_source_symtab->filename);
1680 printf_filtered (_("Expression not found\n"));
1681 do_cleanups (cleanups);
1685 /* If the last character of PATH is a directory separator, then strip it. */
1688 strip_trailing_directory_separator (char *path)
1690 const int last = strlen (path) - 1;
1693 return; /* No stripping is needed if PATH is the empty string. */
1695 if (IS_DIR_SEPARATOR (path[last]))
1699 /* Return the path substitution rule that matches FROM.
1700 Return NULL if no rule matches. */
1702 static struct substitute_path_rule *
1703 find_substitute_path_rule (const char *from)
1705 struct substitute_path_rule *rule = substitute_path_rules;
1707 while (rule != NULL)
1709 if (FILENAME_CMP (rule->from, from) == 0)
1717 /* Add a new substitute-path rule at the end of the current list of rules.
1718 The new rule will replace FROM into TO. */
1721 add_substitute_path_rule (char *from, char *to)
1723 struct substitute_path_rule *rule;
1724 struct substitute_path_rule *new_rule;
1726 new_rule = xmalloc (sizeof (struct substitute_path_rule));
1727 new_rule->from = xstrdup (from);
1728 new_rule->to = xstrdup (to);
1729 new_rule->next = NULL;
1731 /* If the list of rules are empty, then insert the new rule
1732 at the head of the list. */
1734 if (substitute_path_rules == NULL)
1736 substitute_path_rules = new_rule;
1740 /* Otherwise, skip to the last rule in our list and then append
1743 rule = substitute_path_rules;
1744 while (rule->next != NULL)
1747 rule->next = new_rule;
1750 /* Remove the given source path substitution rule from the current list
1751 of rules. The memory allocated for that rule is also deallocated. */
1754 delete_substitute_path_rule (struct substitute_path_rule *rule)
1756 if (rule == substitute_path_rules)
1757 substitute_path_rules = rule->next;
1760 struct substitute_path_rule *prev = substitute_path_rules;
1762 while (prev != NULL && prev->next != rule)
1765 gdb_assert (prev != NULL);
1767 prev->next = rule->next;
1775 /* Implement the "show substitute-path" command. */
1778 show_substitute_path_command (char *args, int from_tty)
1780 struct substitute_path_rule *rule = substitute_path_rules;
1784 argv = gdb_buildargv (args);
1785 make_cleanup_freeargv (argv);
1787 /* We expect zero or one argument. */
1789 if (argv != NULL && argv[0] != NULL && argv[1] != NULL)
1790 error (_("Too many arguments in command"));
1792 if (argv != NULL && argv[0] != NULL)
1795 /* Print the substitution rules. */
1799 (_("Source path substitution rule matching `%s':\n"), from);
1801 printf_filtered (_("List of all source path substitution rules:\n"));
1803 while (rule != NULL)
1805 if (from == NULL || FILENAME_CMP (rule->from, from) == 0)
1806 printf_filtered (" `%s' -> `%s'.\n", rule->from, rule->to);
1811 /* Implement the "unset substitute-path" command. */
1814 unset_substitute_path_command (char *args, int from_tty)
1816 struct substitute_path_rule *rule = substitute_path_rules;
1817 char **argv = gdb_buildargv (args);
1821 /* This function takes either 0 or 1 argument. */
1823 make_cleanup_freeargv (argv);
1824 if (argv != NULL && argv[0] != NULL && argv[1] != NULL)
1825 error (_("Incorrect usage, too many arguments in command"));
1827 if (argv != NULL && argv[0] != NULL)
1830 /* If the user asked for all the rules to be deleted, ask him
1831 to confirm and give him a chance to abort before the action
1835 && !query (_("Delete all source path substitution rules? ")))
1836 error (_("Canceled"));
1838 /* Delete the rule matching the argument. No argument means that
1839 all rules should be deleted. */
1841 while (rule != NULL)
1843 struct substitute_path_rule *next = rule->next;
1845 if (from == NULL || FILENAME_CMP (from, rule->from) == 0)
1847 delete_substitute_path_rule (rule);
1854 /* If the user asked for a specific rule to be deleted but
1855 we could not find it, then report an error. */
1857 if (from != NULL && !rule_found)
1858 error (_("No substitution rule defined for `%s'"), from);
1860 forget_cached_source_info ();
1863 /* Add a new source path substitution rule. */
1866 set_substitute_path_command (char *args, int from_tty)
1869 struct substitute_path_rule *rule;
1871 argv = gdb_buildargv (args);
1872 make_cleanup_freeargv (argv);
1874 if (argv == NULL || argv[0] == NULL || argv [1] == NULL)
1875 error (_("Incorrect usage, too few arguments in command"));
1877 if (argv[2] != NULL)
1878 error (_("Incorrect usage, too many arguments in command"));
1880 if (*(argv[0]) == '\0')
1881 error (_("First argument must be at least one character long"));
1883 /* Strip any trailing directory separator character in either FROM
1884 or TO. The substitution rule already implicitly contains them. */
1885 strip_trailing_directory_separator (argv[0]);
1886 strip_trailing_directory_separator (argv[1]);
1888 /* If a rule with the same "from" was previously defined, then
1889 delete it. This new rule replaces it. */
1891 rule = find_substitute_path_rule (argv[0]);
1893 delete_substitute_path_rule (rule);
1895 /* Insert the new substitution rule. */
1897 add_substitute_path_rule (argv[0], argv[1]);
1898 forget_cached_source_info ();
1903 _initialize_source (void)
1905 struct cmd_list_element *c;
1907 current_source_symtab = 0;
1908 init_source_path ();
1910 /* The intention is to use POSIX Basic Regular Expressions.
1911 Always use the GNU regex routine for consistency across all hosts.
1912 Our current GNU regex.c does not have all the POSIX features, so this is
1913 just an approximation. */
1914 re_set_syntax (RE_SYNTAX_GREP);
1916 c = add_cmd ("directory", class_files, directory_command, _("\
1917 Add directory DIR to beginning of search path for source files.\n\
1918 Forget cached info on source file locations and line positions.\n\
1919 DIR can also be $cwd for the current working directory, or $cdir for the\n\
1920 directory in which the source file was compiled into object code.\n\
1921 With no argument, reset the search path to $cdir:$cwd, the default."),
1925 add_com_alias ("use", "directory", class_files, 0);
1927 set_cmd_completer (c, filename_completer);
1929 add_setshow_optional_filename_cmd ("directories",
1933 Set the search path for finding source files."),
1935 Show the search path for finding source files."),
1937 $cwd in the path means the current working directory.\n\
1938 $cdir in the path means the compilation directory of the source file.\n\
1939 GDB ensures the search path always ends with $cdir:$cwd by\n\
1940 appending these directories if necessary.\n\
1941 Setting the value to an empty string sets it to $cdir:$cwd, the default."),
1942 set_directories_command,
1943 show_directories_command,
1944 &setlist, &showlist);
1948 add_com_alias ("D", "directory", class_files, 0);
1949 add_cmd ("ld", no_class, show_directories_1, _("\
1950 Current search path for finding source files.\n\
1951 $cwd in the path means the current working directory.\n\
1952 $cdir in the path means the compilation directory of the source file."),
1956 add_info ("source", source_info,
1957 _("Information about the current source file."));
1959 add_info ("line", line_info, _("\
1960 Core addresses of the code for a source line.\n\
1961 Line can be specified as\n\
1962 LINENUM, to list around that line in current file,\n\
1963 FILE:LINENUM, to list around that line in that file,\n\
1964 FUNCTION, to list around beginning of that function,\n\
1965 FILE:FUNCTION, to distinguish among like-named static functions.\n\
1966 Default is to describe the last source line that was listed.\n\n\
1967 This sets the default address for \"x\" to the line's first instruction\n\
1968 so that \"x/i\" suffices to start examining the machine code.\n\
1969 The address is also stored as the value of \"$_\"."));
1971 add_com ("forward-search", class_files, forward_search_command, _("\
1972 Search for regular expression (see regex(3)) from last line listed.\n\
1973 The matching line number is also stored as the value of \"$_\"."));
1974 add_com_alias ("search", "forward-search", class_files, 0);
1975 add_com_alias ("fo", "forward-search", class_files, 1);
1977 add_com ("reverse-search", class_files, reverse_search_command, _("\
1978 Search backward for regular expression (see regex(3)) from last line listed.\n\
1979 The matching line number is also stored as the value of \"$_\"."));
1980 add_com_alias ("rev", "reverse-search", class_files, 1);
1984 add_com_alias ("/", "forward-search", class_files, 0);
1985 add_com_alias ("?", "reverse-search", class_files, 0);
1988 add_setshow_zuinteger_unlimited_cmd ("listsize", class_support,
1989 &lines_to_list, _("\
1990 Set number of source lines gdb will list by default."), _("\
1991 Show number of source lines gdb will list by default."), NULL,
1992 NULL, show_lines_to_list,
1993 &setlist, &showlist);
1995 add_cmd ("substitute-path", class_files, set_substitute_path_command,
1997 Usage: set substitute-path FROM TO\n\
1998 Add a substitution rule replacing FROM into TO in source file names.\n\
1999 If a substitution rule was previously set for FROM, the old rule\n\
2000 is replaced by the new one."),
2003 add_cmd ("substitute-path", class_files, unset_substitute_path_command,
2005 Usage: unset substitute-path [FROM]\n\
2006 Delete the rule for substituting FROM in source file names. If FROM\n\
2007 is not specified, all substituting rules are deleted.\n\
2008 If the debugger cannot find a rule for FROM, it will display a warning."),
2011 add_cmd ("substitute-path", class_files, show_substitute_path_command,
2013 Usage: show substitute-path [FROM]\n\
2014 Print the rule for substituting FROM in source file names. If FROM\n\
2015 is not specified, print all substitution rules."),