1 /* List lines of source files for GDB, the GNU debugger.
2 Copyright (C) 1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995,
3 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2007, 2008,
4 2009, 2010, 2011 Free Software Foundation, Inc.
6 This file is part of GDB.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 #include "arch-utils.h"
24 #include "expression.h"
31 #include "gdb_assert.h"
33 #include <sys/types.h>
34 #include "gdb_string.h"
38 #include "gdb_regex.h"
44 #include "filenames.h" /* for DOSish file names */
45 #include "completer.h"
47 #include "readline/readline.h"
52 #define OPEN_MODE (O_RDONLY | O_BINARY)
53 #define FDOPEN_MODE FOPEN_RB
55 /* Prototypes for exported functions. */
57 void _initialize_source (void);
59 /* Prototypes for local functions. */
61 static int get_filename_and_charpos (struct symtab *, char **);
63 static void reverse_search_command (char *, int);
65 static void forward_search_command (char *, int);
67 static void line_info (char *, int);
69 static void source_info (char *, int);
71 /* Path of directories to search for source files.
72 Same format as the PATH environment variable's value. */
76 /* Support for source path substitution commands. */
78 struct substitute_path_rule
82 struct substitute_path_rule *next;
85 static struct substitute_path_rule *substitute_path_rules = NULL;
87 /* Symtab of default file for listing lines of. */
89 static struct symtab *current_source_symtab;
91 /* Default next line to list. */
93 static int current_source_line;
95 static struct program_space *current_source_pspace;
97 /* Default number of lines to print with commands like "list".
98 This is based on guessing how many long (i.e. more than chars_per_line
99 characters) lines there will be. To be completely correct, "list"
100 and friends should be rewritten to count characters and see where
101 things are wrapping, but that would be a fair amount of work. */
103 int lines_to_list = 10;
105 show_lines_to_list (struct ui_file *file, int from_tty,
106 struct cmd_list_element *c, const char *value)
108 fprintf_filtered (file,
109 _("Number of source lines gdb "
110 "will list by default is %s.\n"),
114 /* Line number of last line printed. Default for various commands.
115 current_source_line is usually, but not always, the same as this. */
117 static int last_line_listed;
119 /* First line number listed by last listing command. */
121 static int first_line_listed;
123 /* Saves the name of the last source file visited and a possible error code.
124 Used to prevent repeating annoying "No such file or directories" msgs. */
126 static struct symtab *last_source_visited = NULL;
127 static int last_source_error = 0;
129 /* Return the first line listed by print_source_lines.
130 Used by command interpreters to request listing from
134 get_first_line_listed (void)
136 return first_line_listed;
139 /* Return the default number of lines to print with commands like the
140 cli "list". The caller of print_source_lines must use this to
141 calculate the end line and use it in the call to print_source_lines
142 as it does not automatically use this value. */
145 get_lines_to_list (void)
147 return lines_to_list;
150 /* Return the current source file for listing and next line to list.
151 NOTE: The returned sal pc and end fields are not valid. */
153 struct symtab_and_line
154 get_current_source_symtab_and_line (void)
156 struct symtab_and_line cursal = { 0 };
158 cursal.pspace = current_source_pspace;
159 cursal.symtab = current_source_symtab;
160 cursal.line = current_source_line;
167 /* If the current source file for listing is not set, try and get a default.
168 Usually called before get_current_source_symtab_and_line() is called.
169 It may err out if a default cannot be determined.
170 We must be cautious about where it is called, as it can recurse as the
171 process of determining a new default may call the caller!
172 Use get_current_source_symtab_and_line only to get whatever
173 we have without erroring out or trying to get a default. */
176 set_default_source_symtab_and_line (void)
178 if (!have_full_symbols () && !have_partial_symbols ())
179 error (_("No symbol table is loaded. Use the \"file\" command."));
181 /* Pull in a current source symtab if necessary. */
182 if (current_source_symtab == 0)
183 select_source_symtab (0);
186 /* Return the current default file for listing and next line to list
187 (the returned sal pc and end fields are not valid.)
188 and set the current default to whatever is in SAL.
189 NOTE: The returned sal pc and end fields are not valid. */
191 struct symtab_and_line
192 set_current_source_symtab_and_line (const struct symtab_and_line *sal)
194 struct symtab_and_line cursal = { 0 };
196 cursal.pspace = current_source_pspace;
197 cursal.symtab = current_source_symtab;
198 cursal.line = current_source_line;
202 current_source_pspace = sal->pspace;
203 current_source_symtab = sal->symtab;
204 current_source_line = sal->line;
209 /* Reset any information stored about a default file and line to print. */
212 clear_current_source_symtab_and_line (void)
214 current_source_symtab = 0;
215 current_source_line = 0;
218 /* Set the source file default for the "list" command to be S.
220 If S is NULL, and we don't have a default, find one. This
221 should only be called when the user actually tries to use the
222 default, since we produce an error if we can't find a reasonable
223 default. Also, since this can cause symbols to be read, doing it
224 before we need to would make things slower than necessary. */
227 select_source_symtab (struct symtab *s)
229 struct symtabs_and_lines sals;
230 struct symtab_and_line sal;
235 current_source_symtab = s;
236 current_source_line = 1;
237 current_source_pspace = SYMTAB_PSPACE (s);
241 if (current_source_symtab)
244 /* Make the default place to list be the function `main'
246 if (lookup_symbol (main_name (), 0, VAR_DOMAIN, 0))
248 sals = decode_line_spec (main_name (), 1);
251 current_source_pspace = sal.pspace;
252 current_source_symtab = sal.symtab;
253 current_source_line = max (sal.line - (lines_to_list - 1), 1);
254 if (current_source_symtab)
258 /* Alright; find the last file in the symtab list (ignoring .h's
259 and namespace symtabs). */
261 current_source_line = 1;
265 for (s = ofp->symtabs; s; s = s->next)
267 const char *name = s->filename;
268 int len = strlen (name);
270 if (!(len > 2 && (strcmp (&name[len - 2], ".h") == 0
271 || strcmp (name, "<<C++-namespaces>>") == 0)))
273 current_source_pspace = current_program_space;
274 current_source_symtab = s;
279 if (current_source_symtab)
285 s = ofp->sf->qf->find_last_source_symtab (ofp);
287 current_source_symtab = s;
289 if (current_source_symtab)
292 error (_("Can't find a default source file"));
295 /* Handler for "set directories path-list" command.
296 "set dir mumble" doesn't prepend paths, it resets the entire
297 path list. The theory is that set(show(dir)) should be a no-op. */
300 set_directories_command (char *args, int from_tty, struct cmd_list_element *c)
302 /* This is the value that was set.
303 It needs to be processed to maintain $cdir:$cwd and remove dups. */
304 char *set_path = source_path;
306 /* We preserve the invariant that $cdir:$cwd begins life at the end of
307 the list by calling init_source_path. If they appear earlier in
308 SET_PATH then mod_path will move them appropriately.
309 mod_path will also remove duplicates. */
311 if (*set_path != '\0')
312 mod_path (set_path, &source_path);
317 /* Print the list of source directories.
318 This is used by the "ld" command, so it has the signature of a command
322 show_directories_1 (char *ignore, int from_tty)
324 puts_filtered ("Source directories searched: ");
325 puts_filtered (source_path);
326 puts_filtered ("\n");
329 /* Handler for "show directories" command. */
332 show_directories_command (struct ui_file *file, int from_tty,
333 struct cmd_list_element *c, const char *value)
335 show_directories_1 (NULL, from_tty);
338 /* Forget what we learned about line positions in source files, and
339 which directories contain them; must check again now since files
340 may be found in a different directory now. */
343 forget_cached_source_info (void)
345 struct program_space *pspace;
347 struct objfile *objfile;
350 ALL_PSPACE_OBJFILES (pspace, objfile)
352 for (s = objfile->symtabs; s != NULL; s = s->next)
354 if (s->line_charpos != NULL)
356 xfree (s->line_charpos);
357 s->line_charpos = NULL;
359 if (s->fullname != NULL)
367 objfile->sf->qf->forget_cached_source_info (objfile);
370 last_source_visited = NULL;
374 init_source_path (void)
378 sprintf (buf, "$cdir%c$cwd", DIRNAME_SEPARATOR);
379 source_path = xstrdup (buf);
380 forget_cached_source_info ();
383 /* Add zero or more directories to the front of the source path. */
386 directory_command (char *dirname, int from_tty)
389 /* FIXME, this goes to "delete dir"... */
392 if (!from_tty || query (_("Reinitialize source path to empty? ")))
400 mod_path (dirname, &source_path);
401 forget_cached_source_info ();
404 show_directories_1 ((char *) 0, from_tty);
407 /* Add a path given with the -d command line switch.
408 This will not be quoted so we must not treat spaces as separators. */
411 directory_switch (char *dirname, int from_tty)
413 add_path (dirname, &source_path, 0);
416 /* Add zero or more directories to the front of an arbitrary path. */
419 mod_path (char *dirname, char **which_path)
421 add_path (dirname, which_path, 1);
424 /* Workhorse of mod_path. Takes an extra argument to determine
425 if dirname should be parsed for separators that indicate multiple
426 directories. This allows for interfaces that pre-parse the dirname
427 and allow specification of traditional separator characters such
431 add_path (char *dirname, char **which_path, int parse_separators)
433 char *old = *which_path;
442 if (parse_separators)
444 /* This will properly parse the space and tab separators
445 and any quotes that may exist. DIRNAME_SEPARATOR will
446 be dealt with later. */
447 argv = gdb_buildargv (dirname);
448 make_cleanup_freeargv (argv);
454 arg = xstrdup (dirname);
455 make_cleanup (xfree, arg);
465 char *separator = NULL;
467 /* Spaces and tabs will have been removed by buildargv().
468 The directories will there be split into a list but
469 each entry may still contain DIRNAME_SEPARATOR. */
470 if (parse_separators)
471 separator = strchr (name, DIRNAME_SEPARATOR);
474 p = arg = name + strlen (name);
479 while (*arg == DIRNAME_SEPARATOR)
483 /* If there are no more directories in this argument then start
484 on the next argument next time round the loop (if any). */
486 arg = parse_separators ? argv[++argv_index] : NULL;
489 /* name is the start of the directory.
490 p is the separator (or null) following the end. */
492 while (!(IS_DIR_SEPARATOR (*name) && p <= name + 1) /* "/" */
493 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
494 /* On MS-DOS and MS-Windows, h:\ is different from h: */
495 && !(p == name + 3 && name[1] == ':') /* "d:/" */
497 && IS_DIR_SEPARATOR (p[-1]))
498 /* Sigh. "foo/" => "foo" */
502 while (p > name && p[-1] == '.')
506 /* "." => getwd (). */
507 name = current_directory;
510 else if (p > name + 1 && IS_DIR_SEPARATOR (p[-2]))
520 /* "...foo/." => "...foo". */
531 name = tilde_expand (name);
532 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
533 else if (IS_ABSOLUTE_PATH (name) && p == name + 2) /* "d:" => "d:." */
534 name = concat (name, ".", (char *)NULL);
536 else if (!IS_ABSOLUTE_PATH (name) && name[0] != '$')
537 name = concat (current_directory, SLASH_STRING, name, (char *)NULL);
539 name = savestring (name, p - name);
540 make_cleanup (xfree, name);
542 /* Unless it's a variable, check existence. */
545 /* These are warnings, not errors, since we don't want a
546 non-existent directory in a .gdbinit file to stop processing
547 of the .gdbinit file.
549 Whether they get added to the path is more debatable. Current
550 answer is yes, in case the user wants to go make the directory
551 or whatever. If the directory continues to not exist/not be
552 a directory/etc, then having them in the path should be
554 if (stat (name, &st) < 0)
556 int save_errno = errno;
558 fprintf_unfiltered (gdb_stderr, "Warning: ");
559 print_sys_errmsg (name, save_errno);
561 else if ((st.st_mode & S_IFMT) != S_IFDIR)
562 warning (_("%s is not a directory."), name);
567 unsigned int len = strlen (name);
572 /* FIXME: strncmp loses in interesting ways on MS-DOS and
573 MS-Windows because of case-insensitivity and two different
574 but functionally identical slash characters. We need a
575 special filesystem-dependent file-name comparison function.
577 Actually, even on Unix I would use realpath() or its work-
578 alike before comparing. Then all the code above which
579 removes excess slashes and dots could simply go away. */
580 if (!strncmp (p, name, len)
581 && (p[len] == '\0' || p[len] == DIRNAME_SEPARATOR))
583 /* Found it in the search path, remove old copy. */
585 p--; /* Back over leading separator. */
586 if (prefix > p - *which_path)
587 goto skip_dup; /* Same dir twice in one cmd. */
588 strcpy (p, &p[len + 1]); /* Copy from next \0 or : */
590 p = strchr (p, DIRNAME_SEPARATOR);
600 tinybuf[0] = DIRNAME_SEPARATOR;
603 /* If we have already tacked on a name(s) in this command,
604 be sure they stay on the front as we tack on some
612 temp = concat (old, tinybuf, name, (char *)NULL);
614 *which_path = concat (temp, "", &old[prefix], (char *) NULL);
615 prefix = strlen (temp);
620 *which_path = concat (name, (old[0] ? tinybuf : old),
622 prefix = strlen (name);
635 source_info (char *ignore, int from_tty)
637 struct symtab *s = current_source_symtab;
641 printf_filtered (_("No current source file.\n"));
644 printf_filtered (_("Current source file is %s\n"), s->filename);
646 printf_filtered (_("Compilation directory is %s\n"), s->dirname);
648 printf_filtered (_("Located in %s\n"), s->fullname);
650 printf_filtered (_("Contains %d line%s.\n"), s->nlines,
651 s->nlines == 1 ? "" : "s");
653 printf_filtered (_("Source language is %s.\n"), language_str (s->language));
654 printf_filtered (_("Compiled with %s debugging format.\n"), s->debugformat);
655 printf_filtered (_("%s preprocessor macro info.\n"),
656 s->macro_table ? "Includes" : "Does not include");
660 /* Return True if the file NAME exists and is a regular file. */
662 is_regular_file (const char *name)
665 const int status = stat (name, &st);
667 /* Stat should never fail except when the file does not exist.
668 If stat fails, analyze the source of error and return True
669 unless the file does not exist, to avoid returning false results
670 on obscure systems where stat does not work as expected. */
673 return (errno != ENOENT);
675 return S_ISREG (st.st_mode);
678 /* Open a file named STRING, searching path PATH (dir names sep by some char)
679 using mode MODE in the calls to open. You cannot use this function to
680 create files (O_CREAT).
682 OPTS specifies the function behaviour in specific cases.
684 If OPF_TRY_CWD_FIRST, try to open ./STRING before searching PATH.
685 (ie pretend the first element of PATH is "."). This also indicates
686 that a slash in STRING disables searching of the path (this is
687 so that "exec-file ./foo" or "symbol-file ./foo" insures that you
688 get that particular version of foo or an error message).
690 If OPTS has OPF_SEARCH_IN_PATH set, absolute names will also be
691 searched in path (we usually want this for source files but not for
694 If FILENAME_OPENED is non-null, set it to a newly allocated string naming
695 the actual file opened (this string will always start with a "/"). We
696 have to take special pains to avoid doubling the "/" between the directory
697 and the file, sigh! Emacs gets confuzzed by this when we print the
700 If a file is found, return the descriptor.
701 Otherwise, return -1, with errno set for the last name we tried to open. */
703 /* >>>> This should only allow files of certain types,
704 >>>> eg executable, non-directory. */
706 openp (const char *path, int opts, const char *string,
707 int mode, char **filename_opened)
716 /* The open syscall MODE parameter is not specified. */
717 gdb_assert ((mode & O_CREAT) == 0);
718 gdb_assert (string != NULL);
720 /* A file with an empty name cannot possibly exist. Report a failure
721 without further checking.
723 This is an optimization which also defends us against buggy
724 implementations of the "stat" function. For instance, we have
725 noticed that a MinGW debugger built on Windows XP 32bits crashes
726 when the debugger is started with an empty argument. */
727 if (string[0] == '\0')
738 if ((opts & OPF_TRY_CWD_FIRST) || IS_ABSOLUTE_PATH (string))
742 if (is_regular_file (string))
744 filename = alloca (strlen (string) + 1);
745 strcpy (filename, string);
746 fd = open (filename, mode);
756 if (!(opts & OPF_SEARCH_IN_PATH))
757 for (i = 0; string[i]; i++)
758 if (IS_DIR_SEPARATOR (string[i]))
762 /* For dos paths, d:/foo -> /foo, and d:foo -> foo. */
763 if (HAS_DRIVE_SPEC (string))
764 string = STRIP_DRIVE_SPEC (string);
766 /* /foo => foo, to avoid multiple slashes that Emacs doesn't like. */
767 while (IS_DIR_SEPARATOR(string[0]))
771 while (string[0] == '.' && IS_DIR_SEPARATOR (string[1]))
774 alloclen = strlen (path) + strlen (string) + 2;
775 filename = alloca (alloclen);
777 for (p = path; p; p = p1 ? p1 + 1 : 0)
779 p1 = strchr (p, DIRNAME_SEPARATOR);
785 if (len == 4 && p[0] == '$' && p[1] == 'c'
786 && p[2] == 'w' && p[3] == 'd')
788 /* Name is $cwd -- insert current directory name instead. */
791 /* First, realloc the filename buffer if too short. */
792 len = strlen (current_directory);
793 newlen = len + strlen (string) + 2;
794 if (newlen > alloclen)
797 filename = alloca (alloclen);
799 strcpy (filename, current_directory);
803 /* Normal file name in path -- just use it. */
804 strncpy (filename, p, len);
807 /* Don't search $cdir. It's also a magic path like $cwd, but we
808 don't have enough information to expand it. The user *could*
809 have an actual directory named '$cdir' but handling that would
810 be confusing, it would mean different things in different
811 contexts. If the user really has '$cdir' one can use './$cdir'.
812 We can get $cdir when loading scripts. When loading source files
813 $cdir must have already been expanded to the correct value. */
814 if (strcmp (filename, "$cdir") == 0)
818 /* Remove trailing slashes. */
819 while (len > 0 && IS_DIR_SEPARATOR (filename[len - 1]))
822 strcat (filename + len, SLASH_STRING);
823 strcat (filename, string);
825 if (is_regular_file (filename))
827 fd = open (filename, mode);
836 /* If a file was opened, canonicalize its filename. Use xfullpath
837 rather than gdb_realpath to avoid resolving the basename part
838 of filenames when the associated file is a symbolic link. This
839 fixes a potential inconsistency between the filenames known to
840 GDB and the filenames it prints in the annotations. */
842 *filename_opened = NULL;
843 else if (IS_ABSOLUTE_PATH (filename))
844 *filename_opened = xfullpath (filename);
847 /* Beware the // my son, the Emacs barfs, the botch that catch... */
849 char *f = concat (current_directory,
850 IS_DIR_SEPARATOR (current_directory[strlen (current_directory) - 1])
852 filename, (char *)NULL);
854 *filename_opened = xfullpath (f);
863 /* This is essentially a convenience, for clients that want the behaviour
864 of openp, using source_path, but that really don't want the file to be
865 opened but want instead just to know what the full pathname is (as
866 qualified against source_path).
868 The current working directory is searched first.
870 If the file was found, this function returns 1, and FULL_PATHNAME is
871 set to the fully-qualified pathname.
873 Else, this functions returns 0, and FULL_PATHNAME is set to NULL. */
875 source_full_path_of (const char *filename, char **full_pathname)
879 fd = openp (source_path, OPF_TRY_CWD_FIRST | OPF_SEARCH_IN_PATH, filename,
880 O_RDONLY, full_pathname);
883 *full_pathname = NULL;
891 /* Return non-zero if RULE matches PATH, that is if the rule can be
895 substitute_path_rule_matches (const struct substitute_path_rule *rule,
898 const int from_len = strlen (rule->from);
899 const int path_len = strlen (path);
902 if (path_len < from_len)
905 /* The substitution rules are anchored at the start of the path,
906 so the path should start with rule->from. There is no filename
907 comparison routine, so we need to extract the first FROM_LEN
908 characters from PATH first and use that to do the comparison. */
910 path_start = alloca (from_len + 1);
911 strncpy (path_start, path, from_len);
912 path_start[from_len] = '\0';
914 if (FILENAME_CMP (path_start, rule->from) != 0)
917 /* Make sure that the region in the path that matches the substitution
918 rule is immediately followed by a directory separator (or the end of
919 string character). */
921 if (path[from_len] != '\0' && !IS_DIR_SEPARATOR (path[from_len]))
927 /* Find the substitute-path rule that applies to PATH and return it.
928 Return NULL if no rule applies. */
930 static struct substitute_path_rule *
931 get_substitute_path_rule (const char *path)
933 struct substitute_path_rule *rule = substitute_path_rules;
935 while (rule != NULL && !substitute_path_rule_matches (rule, path))
941 /* If the user specified a source path substitution rule that applies
942 to PATH, then apply it and return the new path. This new path must
943 be deallocated afterwards.
945 Return NULL if no substitution rule was specified by the user,
946 or if no rule applied to the given PATH. */
949 rewrite_source_path (const char *path)
951 const struct substitute_path_rule *rule = get_substitute_path_rule (path);
958 from_len = strlen (rule->from);
960 /* Compute the rewritten path and return it. */
963 (char *) xmalloc (strlen (path) + 1 + strlen (rule->to) - from_len);
964 strcpy (new_path, rule->to);
965 strcat (new_path, path + from_len);
970 /* This function is capable of finding the absolute path to a
971 source file, and opening it, provided you give it a FILENAME. Both the
972 DIRNAME and FULLNAME are only added suggestions on where to find the file.
974 FILENAME should be the filename to open.
975 DIRNAME is the compilation directory of a particular source file.
976 Only some debug formats provide this info.
977 FULLNAME can be the last known absolute path to the file in question.
978 Space for the path must have been malloc'd. If a path substitution
979 is applied we free the old value and set a new one.
982 A valid file descriptor is returned (the return value is positive).
983 FULLNAME is set to the absolute path to the file just opened.
984 The caller is responsible for freeing FULLNAME.
987 An invalid file descriptor is returned (the return value is negative).
988 FULLNAME is set to NULL. */
991 find_and_open_source (const char *filename,
995 char *path = source_path;
999 /* Quick way out if we already know its full name. */
1003 /* The user may have requested that source paths be rewritten
1004 according to substitution rules he provided. If a substitution
1005 rule applies to this path, then apply it. */
1006 char *rewritten_fullname = rewrite_source_path (*fullname);
1008 if (rewritten_fullname != NULL)
1011 *fullname = rewritten_fullname;
1014 result = open (*fullname, OPEN_MODE);
1017 /* Didn't work -- free old one, try again. */
1022 if (dirname != NULL)
1024 /* If necessary, rewrite the compilation directory name according
1025 to the source path substitution rules specified by the user. */
1027 char *rewritten_dirname = rewrite_source_path (dirname);
1029 if (rewritten_dirname != NULL)
1031 make_cleanup (xfree, rewritten_dirname);
1032 dirname = rewritten_dirname;
1035 /* Replace a path entry of $cdir with the compilation directory
1038 /* We cast strstr's result in case an ANSIhole has made it const,
1039 which produces a "required warning" when assigned to a nonconst. */
1040 p = (char *) strstr (source_path, "$cdir");
1041 if (p && (p == path || p[-1] == DIRNAME_SEPARATOR)
1042 && (p[cdir_len] == DIRNAME_SEPARATOR || p[cdir_len] == '\0'))
1047 alloca (strlen (source_path) + 1 + strlen (dirname) + 1);
1048 len = p - source_path;
1049 strncpy (path, source_path, len); /* Before $cdir */
1050 strcpy (path + len, dirname); /* new stuff */
1051 strcat (path + len, source_path + len + cdir_len); /* After
1056 if (IS_ABSOLUTE_PATH (filename))
1058 /* If filename is absolute path, try the source path
1059 substitution on it. */
1060 char *rewritten_filename = rewrite_source_path (filename);
1062 if (rewritten_filename != NULL)
1064 make_cleanup (xfree, rewritten_filename);
1065 filename = rewritten_filename;
1069 result = openp (path, OPF_SEARCH_IN_PATH, filename, OPEN_MODE, fullname);
1072 /* Didn't work. Try using just the basename. */
1073 p = lbasename (filename);
1075 result = openp (path, OPF_SEARCH_IN_PATH, p, OPEN_MODE, fullname);
1081 /* Open a source file given a symtab S. Returns a file descriptor or
1082 negative number for error.
1084 This function is a convience function to find_and_open_source. */
1087 open_source_file (struct symtab *s)
1092 return find_and_open_source (s->filename, s->dirname, &s->fullname);
1095 /* Finds the fullname that a symtab represents.
1097 If this functions finds the fullname, it will save it in s->fullname
1098 and it will also return the value.
1100 If this function fails to find the file that this symtab represents,
1101 NULL will be returned and s->fullname will be set to NULL. */
1103 symtab_to_fullname (struct symtab *s)
1110 /* Don't check s->fullname here, the file could have been
1111 deleted/moved/..., look for it again. */
1112 r = find_and_open_source (s->filename, s->dirname, &s->fullname);
1123 /* Create and initialize the table S->line_charpos that records
1124 the positions of the lines in the source file, which is assumed
1125 to be open on descriptor DESC.
1126 All set S->nlines to the number of such lines. */
1129 find_source_lines (struct symtab *s, int desc)
1132 char *data, *p, *end;
1134 int lines_allocated = 1000;
1140 line_charpos = (int *) xmalloc (lines_allocated * sizeof (int));
1141 if (fstat (desc, &st) < 0)
1142 perror_with_name (s->filename);
1144 if (s->objfile && s->objfile->obfd)
1145 mtime = s->objfile->mtime;
1147 mtime = exec_bfd_mtime;
1149 if (mtime && mtime < st.st_mtime)
1150 warning (_("Source file is more recent than executable."));
1152 #ifdef LSEEK_NOT_LINEAR
1156 /* Have to read it byte by byte to find out where the chars live. */
1158 line_charpos[0] = lseek (desc, 0, SEEK_CUR);
1160 while (myread (desc, &c, 1) > 0)
1164 if (nlines == lines_allocated)
1166 lines_allocated *= 2;
1168 (int *) xrealloc ((char *) line_charpos,
1169 sizeof (int) * lines_allocated);
1171 line_charpos[nlines++] = lseek (desc, 0, SEEK_CUR);
1175 #else /* lseek linear. */
1177 struct cleanup *old_cleanups;
1179 /* st_size might be a large type, but we only support source files whose
1180 size fits in an int. */
1181 size = (int) st.st_size;
1183 /* Use malloc, not alloca, because this may be pretty large, and we may
1184 run into various kinds of limits on stack size. */
1185 data = (char *) xmalloc (size);
1186 old_cleanups = make_cleanup (xfree, data);
1188 /* Reassign `size' to result of read for systems where \r\n -> \n. */
1189 size = myread (desc, data, size);
1191 perror_with_name (s->filename);
1194 line_charpos[0] = 0;
1199 /* A newline at the end does not start a new line. */
1202 if (nlines == lines_allocated)
1204 lines_allocated *= 2;
1206 (int *) xrealloc ((char *) line_charpos,
1207 sizeof (int) * lines_allocated);
1209 line_charpos[nlines++] = p - data;
1212 do_cleanups (old_cleanups);
1214 #endif /* lseek linear. */
1217 (int *) xrealloc ((char *) line_charpos, nlines * sizeof (int));
1221 /* Return the character position of a line LINE in symtab S.
1222 Return 0 if anything is invalid. */
1224 #if 0 /* Currently unused */
1227 source_line_charpos (struct symtab *s, int line)
1231 if (!s->line_charpos || line <= 0)
1233 if (line > s->nlines)
1235 return s->line_charpos[line - 1];
1238 /* Return the line number of character position POS in symtab S. */
1241 source_charpos_line (struct symtab *s, int chr)
1246 if (s == 0 || s->line_charpos == 0)
1248 lnp = s->line_charpos;
1249 /* Files are usually short, so sequential search is Ok. */
1250 while (line < s->nlines && *lnp <= chr)
1255 if (line >= s->nlines)
1263 /* Get full pathname and line number positions for a symtab.
1264 Return nonzero if line numbers may have changed.
1265 Set *FULLNAME to actual name of the file as found by `openp',
1266 or to 0 if the file is not found. */
1269 get_filename_and_charpos (struct symtab *s, char **fullname)
1271 int desc, linenums_changed = 0;
1272 struct cleanup *cleanups;
1274 desc = open_source_file (s);
1281 cleanups = make_cleanup_close (desc);
1283 *fullname = s->fullname;
1284 if (s->line_charpos == 0)
1285 linenums_changed = 1;
1286 if (linenums_changed)
1287 find_source_lines (s, desc);
1288 do_cleanups (cleanups);
1289 return linenums_changed;
1292 /* Print text describing the full name of the source file S
1293 and the line number LINE and its corresponding character position.
1294 The text starts with two Ctrl-z so that the Emacs-GDB interface
1297 MID_STATEMENT is nonzero if the PC is not at the beginning of that line.
1299 Return 1 if successful, 0 if could not find the file. */
1302 identify_source_line (struct symtab *s, int line, int mid_statement,
1305 if (s->line_charpos == 0)
1306 get_filename_and_charpos (s, (char **) NULL);
1307 if (s->fullname == 0)
1309 if (line > s->nlines)
1310 /* Don't index off the end of the line_charpos array. */
1312 annotate_source (s->fullname, line, s->line_charpos[line - 1],
1313 mid_statement, get_objfile_arch (s->objfile), pc);
1315 current_source_line = line;
1316 first_line_listed = line;
1317 last_line_listed = line;
1318 current_source_symtab = s;
1323 /* Print source lines from the file of symtab S,
1324 starting with line number LINE and stopping before line number STOPLINE. */
1326 static void print_source_lines_base (struct symtab *s, int line, int stopline,
1329 print_source_lines_base (struct symtab *s, int line, int stopline, int noerror)
1335 int nlines = stopline - line;
1336 struct cleanup *cleanup;
1338 /* Regardless of whether we can open the file, set current_source_symtab. */
1339 current_source_symtab = s;
1340 current_source_line = line;
1341 first_line_listed = line;
1343 /* If printing of source lines is disabled, just print file and line
1345 if (ui_out_test_flags (uiout, ui_source_list))
1347 /* Only prints "No such file or directory" once. */
1348 if ((s != last_source_visited) || (!last_source_error))
1350 last_source_visited = s;
1351 desc = open_source_file (s);
1355 desc = last_source_error;
1361 desc = last_source_error;
1366 if (desc < 0 || noprint)
1368 last_source_error = desc;
1372 char *name = alloca (strlen (s->filename) + 100);
1373 sprintf (name, "%d\t%s", line, s->filename);
1374 print_sys_errmsg (name, errno);
1377 ui_out_field_int (uiout, "line", line);
1378 ui_out_text (uiout, "\tin ");
1379 ui_out_field_string (uiout, "file", s->filename);
1380 ui_out_text (uiout, "\n");
1385 last_source_error = 0;
1387 if (s->line_charpos == 0)
1388 find_source_lines (s, desc);
1390 if (line < 1 || line > s->nlines)
1393 error (_("Line number %d out of range; %s has %d lines."),
1394 line, s->filename, s->nlines);
1397 if (lseek (desc, s->line_charpos[line - 1], 0) < 0)
1400 perror_with_name (s->filename);
1403 stream = fdopen (desc, FDOPEN_MODE);
1405 cleanup = make_cleanup_fclose (stream);
1407 while (nlines-- > 0)
1414 last_line_listed = current_source_line;
1415 sprintf (buf, "%d\t", current_source_line++);
1416 ui_out_text (uiout, buf);
1419 if (c < 040 && c != '\t' && c != '\n' && c != '\r')
1421 sprintf (buf, "^%c", c + 0100);
1422 ui_out_text (uiout, buf);
1425 ui_out_text (uiout, "^?");
1428 /* Skip a \r character, but only before a \n. */
1429 int c1 = fgetc (stream);
1432 printf_filtered ("^%c", c + 0100);
1434 ungetc (c1, stream);
1438 sprintf (buf, "%c", c);
1439 ui_out_text (uiout, buf);
1442 while (c != '\n' && (c = fgetc (stream)) >= 0);
1445 do_cleanups (cleanup);
1448 /* Show source lines from the file of symtab S, starting with line
1449 number LINE and stopping before line number STOPLINE. If this is
1450 not the command line version, then the source is shown in the source
1451 window otherwise it is simply printed. */
1454 print_source_lines (struct symtab *s, int line, int stopline, int noerror)
1456 print_source_lines_base (s, line, stopline, noerror);
1459 /* Print info on range of pc's in a specified line. */
1462 line_info (char *arg, int from_tty)
1464 struct symtabs_and_lines sals;
1465 struct symtab_and_line sal;
1466 CORE_ADDR start_pc, end_pc;
1469 init_sal (&sal); /* initialize to zeroes */
1473 sal.symtab = current_source_symtab;
1474 sal.line = last_line_listed;
1476 sals.sals = (struct symtab_and_line *)
1477 xmalloc (sizeof (struct symtab_and_line));
1482 sals = decode_line_spec_1 (arg, 0);
1487 /* C++ More than one line may have been specified, as when the user
1488 specifies an overloaded function name. Print info on them all. */
1489 for (i = 0; i < sals.nelts; i++)
1493 if (sal.symtab == 0)
1495 struct gdbarch *gdbarch = get_current_arch ();
1497 printf_filtered (_("No line number information available"));
1500 /* This is useful for "info line *0x7f34". If we can't tell the
1501 user about a source line, at least let them have the symbolic
1503 printf_filtered (" for address ");
1505 print_address (gdbarch, sal.pc, gdb_stdout);
1508 printf_filtered (".");
1509 printf_filtered ("\n");
1511 else if (sal.line > 0
1512 && find_line_pc_range (sal, &start_pc, &end_pc))
1514 struct gdbarch *gdbarch = get_objfile_arch (sal.symtab->objfile);
1516 if (start_pc == end_pc)
1518 printf_filtered ("Line %d of \"%s\"",
1519 sal.line, sal.symtab->filename);
1521 printf_filtered (" is at address ");
1522 print_address (gdbarch, start_pc, gdb_stdout);
1524 printf_filtered (" but contains no code.\n");
1528 printf_filtered ("Line %d of \"%s\"",
1529 sal.line, sal.symtab->filename);
1531 printf_filtered (" starts at address ");
1532 print_address (gdbarch, start_pc, gdb_stdout);
1534 printf_filtered (" and ends at ");
1535 print_address (gdbarch, end_pc, gdb_stdout);
1536 printf_filtered (".\n");
1539 /* x/i should display this line's code. */
1540 set_next_address (gdbarch, start_pc);
1542 /* Repeating "info line" should do the following line. */
1543 last_line_listed = sal.line + 1;
1545 /* If this is the only line, show the source code. If it could
1546 not find the file, don't do anything special. */
1547 if (annotation_level && sals.nelts == 1)
1548 identify_source_line (sal.symtab, sal.line, 0, start_pc);
1551 /* Is there any case in which we get here, and have an address
1552 which the user would want to see? If we have debugging symbols
1553 and no line numbers? */
1554 printf_filtered (_("Line number %d is out of range for \"%s\".\n"),
1555 sal.line, sal.symtab->filename);
1560 /* Commands to search the source file for a regexp. */
1563 forward_search_command (char *regex, int from_tty)
1570 struct cleanup *cleanups;
1572 line = last_line_listed + 1;
1574 msg = (char *) re_comp (regex);
1576 error (("%s"), msg);
1578 if (current_source_symtab == 0)
1579 select_source_symtab (0);
1581 desc = open_source_file (current_source_symtab);
1583 perror_with_name (current_source_symtab->filename);
1584 cleanups = make_cleanup_close (desc);
1586 if (current_source_symtab->line_charpos == 0)
1587 find_source_lines (current_source_symtab, desc);
1589 if (line < 1 || line > current_source_symtab->nlines)
1590 error (_("Expression not found"));
1592 if (lseek (desc, current_source_symtab->line_charpos[line - 1], 0) < 0)
1593 perror_with_name (current_source_symtab->filename);
1595 discard_cleanups (cleanups);
1596 stream = fdopen (desc, FDOPEN_MODE);
1598 cleanups = make_cleanup_fclose (stream);
1601 static char *buf = NULL;
1603 int cursize, newsize;
1606 buf = xmalloc (cursize);
1615 if (p - buf == cursize)
1617 newsize = cursize + cursize / 2;
1618 buf = xrealloc (buf, newsize);
1623 while (c != '\n' && (c = getc (stream)) >= 0);
1625 /* Remove the \r, if any, at the end of the line, otherwise
1626 regular expressions that end with $ or \n won't work. */
1627 if (p - buf > 1 && p[-2] == '\r')
1633 /* We now have a source line in buf, null terminate and match. */
1635 if (re_exec (buf) > 0)
1638 do_cleanups (cleanups);
1639 print_source_lines (current_source_symtab, line, line + 1, 0);
1640 set_internalvar_integer (lookup_internalvar ("_"), line);
1641 current_source_line = max (line - lines_to_list / 2, 1);
1647 printf_filtered (_("Expression not found\n"));
1648 do_cleanups (cleanups);
1652 reverse_search_command (char *regex, int from_tty)
1659 struct cleanup *cleanups;
1661 line = last_line_listed - 1;
1663 msg = (char *) re_comp (regex);
1665 error (("%s"), msg);
1667 if (current_source_symtab == 0)
1668 select_source_symtab (0);
1670 desc = open_source_file (current_source_symtab);
1672 perror_with_name (current_source_symtab->filename);
1673 cleanups = make_cleanup_close (desc);
1675 if (current_source_symtab->line_charpos == 0)
1676 find_source_lines (current_source_symtab, desc);
1678 if (line < 1 || line > current_source_symtab->nlines)
1679 error (_("Expression not found"));
1681 if (lseek (desc, current_source_symtab->line_charpos[line - 1], 0) < 0)
1682 perror_with_name (current_source_symtab->filename);
1684 discard_cleanups (cleanups);
1685 stream = fdopen (desc, FDOPEN_MODE);
1687 cleanups = make_cleanup_fclose (stream);
1690 /* FIXME!!! We walk right off the end of buf if we get a long line!!! */
1691 char buf[4096]; /* Should be reasonable??? */
1701 while (c != '\n' && (c = getc (stream)) >= 0);
1703 /* Remove the \r, if any, at the end of the line, otherwise
1704 regular expressions that end with $ or \n won't work. */
1705 if (p - buf > 1 && p[-2] == '\r')
1711 /* We now have a source line in buf; null terminate and match. */
1713 if (re_exec (buf) > 0)
1716 do_cleanups (cleanups);
1717 print_source_lines (current_source_symtab, line, line + 1, 0);
1718 set_internalvar_integer (lookup_internalvar ("_"), line);
1719 current_source_line = max (line - lines_to_list / 2, 1);
1723 if (fseek (stream, current_source_symtab->line_charpos[line - 1], 0) < 0)
1725 do_cleanups (cleanups);
1726 perror_with_name (current_source_symtab->filename);
1730 printf_filtered (_("Expression not found\n"));
1731 do_cleanups (cleanups);
1735 /* If the last character of PATH is a directory separator, then strip it. */
1738 strip_trailing_directory_separator (char *path)
1740 const int last = strlen (path) - 1;
1743 return; /* No stripping is needed if PATH is the empty string. */
1745 if (IS_DIR_SEPARATOR (path[last]))
1749 /* Return the path substitution rule that matches FROM.
1750 Return NULL if no rule matches. */
1752 static struct substitute_path_rule *
1753 find_substitute_path_rule (const char *from)
1755 struct substitute_path_rule *rule = substitute_path_rules;
1757 while (rule != NULL)
1759 if (FILENAME_CMP (rule->from, from) == 0)
1767 /* Add a new substitute-path rule at the end of the current list of rules.
1768 The new rule will replace FROM into TO. */
1771 add_substitute_path_rule (char *from, char *to)
1773 struct substitute_path_rule *rule;
1774 struct substitute_path_rule *new_rule;
1776 new_rule = xmalloc (sizeof (struct substitute_path_rule));
1777 new_rule->from = xstrdup (from);
1778 new_rule->to = xstrdup (to);
1779 new_rule->next = NULL;
1781 /* If the list of rules are empty, then insert the new rule
1782 at the head of the list. */
1784 if (substitute_path_rules == NULL)
1786 substitute_path_rules = new_rule;
1790 /* Otherwise, skip to the last rule in our list and then append
1793 rule = substitute_path_rules;
1794 while (rule->next != NULL)
1797 rule->next = new_rule;
1800 /* Remove the given source path substitution rule from the current list
1801 of rules. The memory allocated for that rule is also deallocated. */
1804 delete_substitute_path_rule (struct substitute_path_rule *rule)
1806 if (rule == substitute_path_rules)
1807 substitute_path_rules = rule->next;
1810 struct substitute_path_rule *prev = substitute_path_rules;
1812 while (prev != NULL && prev->next != rule)
1815 gdb_assert (prev != NULL);
1817 prev->next = rule->next;
1825 /* Implement the "show substitute-path" command. */
1828 show_substitute_path_command (char *args, int from_tty)
1830 struct substitute_path_rule *rule = substitute_path_rules;
1834 argv = gdb_buildargv (args);
1835 make_cleanup_freeargv (argv);
1837 /* We expect zero or one argument. */
1839 if (argv != NULL && argv[0] != NULL && argv[1] != NULL)
1840 error (_("Too many arguments in command"));
1842 if (argv != NULL && argv[0] != NULL)
1845 /* Print the substitution rules. */
1849 (_("Source path substitution rule matching `%s':\n"), from);
1851 printf_filtered (_("List of all source path substitution rules:\n"));
1853 while (rule != NULL)
1855 if (from == NULL || FILENAME_CMP (rule->from, from) == 0)
1856 printf_filtered (" `%s' -> `%s'.\n", rule->from, rule->to);
1861 /* Implement the "unset substitute-path" command. */
1864 unset_substitute_path_command (char *args, int from_tty)
1866 struct substitute_path_rule *rule = substitute_path_rules;
1867 char **argv = gdb_buildargv (args);
1871 /* This function takes either 0 or 1 argument. */
1873 make_cleanup_freeargv (argv);
1874 if (argv != NULL && argv[0] != NULL && argv[1] != NULL)
1875 error (_("Incorrect usage, too many arguments in command"));
1877 if (argv != NULL && argv[0] != NULL)
1880 /* If the user asked for all the rules to be deleted, ask him
1881 to confirm and give him a chance to abort before the action
1885 && !query (_("Delete all source path substitution rules? ")))
1886 error (_("Canceled"));
1888 /* Delete the rule matching the argument. No argument means that
1889 all rules should be deleted. */
1891 while (rule != NULL)
1893 struct substitute_path_rule *next = rule->next;
1895 if (from == NULL || FILENAME_CMP (from, rule->from) == 0)
1897 delete_substitute_path_rule (rule);
1904 /* If the user asked for a specific rule to be deleted but
1905 we could not find it, then report an error. */
1907 if (from != NULL && !rule_found)
1908 error (_("No substitution rule defined for `%s'"), from);
1910 forget_cached_source_info ();
1913 /* Add a new source path substitution rule. */
1916 set_substitute_path_command (char *args, int from_tty)
1919 struct substitute_path_rule *rule;
1921 argv = gdb_buildargv (args);
1922 make_cleanup_freeargv (argv);
1924 if (argv == NULL || argv[0] == NULL || argv [1] == NULL)
1925 error (_("Incorrect usage, too few arguments in command"));
1927 if (argv[2] != NULL)
1928 error (_("Incorrect usage, too many arguments in command"));
1930 if (*(argv[0]) == '\0')
1931 error (_("First argument must be at least one character long"));
1933 /* Strip any trailing directory separator character in either FROM
1934 or TO. The substitution rule already implicitly contains them. */
1935 strip_trailing_directory_separator (argv[0]);
1936 strip_trailing_directory_separator (argv[1]);
1938 /* If a rule with the same "from" was previously defined, then
1939 delete it. This new rule replaces it. */
1941 rule = find_substitute_path_rule (argv[0]);
1943 delete_substitute_path_rule (rule);
1945 /* Insert the new substitution rule. */
1947 add_substitute_path_rule (argv[0], argv[1]);
1948 forget_cached_source_info ();
1953 _initialize_source (void)
1955 struct cmd_list_element *c;
1957 current_source_symtab = 0;
1958 init_source_path ();
1960 /* The intention is to use POSIX Basic Regular Expressions.
1961 Always use the GNU regex routine for consistency across all hosts.
1962 Our current GNU regex.c does not have all the POSIX features, so this is
1963 just an approximation. */
1964 re_set_syntax (RE_SYNTAX_GREP);
1966 c = add_cmd ("directory", class_files, directory_command, _("\
1967 Add directory DIR to beginning of search path for source files.\n\
1968 Forget cached info on source file locations and line positions.\n\
1969 DIR can also be $cwd for the current working directory, or $cdir for the\n\
1970 directory in which the source file was compiled into object code.\n\
1971 With no argument, reset the search path to $cdir:$cwd, the default."),
1975 add_com_alias ("use", "directory", class_files, 0);
1977 set_cmd_completer (c, filename_completer);
1979 add_setshow_optional_filename_cmd ("directories",
1983 Set the search path for finding source files."),
1985 Show the search path for finding source files."),
1987 $cwd in the path means the current working directory.\n\
1988 $cdir in the path means the compilation directory of the source file.\n\
1989 GDB ensures the search path always ends with $cdir:$cwd by\n\
1990 appending these directories if necessary.\n\
1991 Setting the value to an empty string sets it to $cdir:$cwd, the default."),
1992 set_directories_command,
1993 show_directories_command,
1994 &setlist, &showlist);
1998 add_com_alias ("D", "directory", class_files, 0);
1999 add_cmd ("ld", no_class, show_directories_1, _("\
2000 Current search path for finding source files.\n\
2001 $cwd in the path means the current working directory.\n\
2002 $cdir in the path means the compilation directory of the source file."),
2006 add_info ("source", source_info,
2007 _("Information about the current source file."));
2009 add_info ("line", line_info, _("\
2010 Core addresses of the code for a source line.\n\
2011 Line can be specified as\n\
2012 LINENUM, to list around that line in current file,\n\
2013 FILE:LINENUM, to list around that line in that file,\n\
2014 FUNCTION, to list around beginning of that function,\n\
2015 FILE:FUNCTION, to distinguish among like-named static functions.\n\
2016 Default is to describe the last source line that was listed.\n\n\
2017 This sets the default address for \"x\" to the line's first instruction\n\
2018 so that \"x/i\" suffices to start examining the machine code.\n\
2019 The address is also stored as the value of \"$_\"."));
2021 add_com ("forward-search", class_files, forward_search_command, _("\
2022 Search for regular expression (see regex(3)) from last line listed.\n\
2023 The matching line number is also stored as the value of \"$_\"."));
2024 add_com_alias ("search", "forward-search", class_files, 0);
2026 add_com ("reverse-search", class_files, reverse_search_command, _("\
2027 Search backward for regular expression (see regex(3)) from last line listed.\n\
2028 The matching line number is also stored as the value of \"$_\"."));
2029 add_com_alias ("rev", "reverse-search", class_files, 1);
2033 add_com_alias ("/", "forward-search", class_files, 0);
2034 add_com_alias ("?", "reverse-search", class_files, 0);
2037 add_setshow_integer_cmd ("listsize", class_support, &lines_to_list, _("\
2038 Set number of source lines gdb will list by default."), _("\
2039 Show number of source lines gdb will list by default."), NULL,
2042 &setlist, &showlist);
2044 add_cmd ("substitute-path", class_files, set_substitute_path_command,
2046 Usage: set substitute-path FROM TO\n\
2047 Add a substitution rule replacing FROM into TO in source file names.\n\
2048 If a substitution rule was previously set for FROM, the old rule\n\
2049 is replaced by the new one."),
2052 add_cmd ("substitute-path", class_files, unset_substitute_path_command,
2054 Usage: unset substitute-path [FROM]\n\
2055 Delete the rule for substituting FROM in source file names. If FROM\n\
2056 is not specified, all substituting rules are deleted.\n\
2057 If the debugger cannot find a rule for FROM, it will display a warning."),
2060 add_cmd ("substitute-path", class_files, show_substitute_path_command,
2062 Usage: show substitute-path [FROM]\n\
2063 Print the rule for substituting FROM in source file names. If FROM\n\
2064 is not specified, print all substitution rules."),