mirror of
https://sourceware.org/git/binutils-gdb.git
synced 2025-03-07 13:39:43 +08:00
ea4c968ce5
I spotted that the gdb.base/sysroot-debug-lookup.exp test that I added
recently actually had a KPASS when run with the
native-extended-gdbserver board. This was an oversight when adding
the test.
The failures in this test, when using the 'unix' board, are logged as
bug PR gdb/31804. The problem appears to be caused by the use of the
child_path function in find_separate_debug_file.
What happens on the 'unix' board is that the file is specified to GDB
with a target: prefix, however GDB spots that the target filesystem is
local to GDB and so opens the file without a target: prefix. When we
call into find_separate_debug_file the DIR and CANON_DIR arguments,
which are computed from the objfile_name() no longer have a target:
prefix.
However, in this test if the file was opened with a target: prefix,
then the sysroot also has a target: prefix. When child_path is called
it looks for a common prefix between CANON_DIR (from the objfile_name)
and the sysroot. However, the sysroot still has the target: prefix,
which means the child_path() call fails and returns nullptr.
What happens in the native-extended-gdbserver case is that GDB doesn't
see the target filesystem as local. Now the filename retains the
target: prefix, which means that in the child_path() call both the
sysroot and the CANON_DIR have a target: prefix, and so the
child_path() call succeeds. This allows GDB to progress, try some
additional paths, and then find the debug information.
So, this commit changes gdb.base/sysroot-debug-lookup.exp to expect
the test to succeed when using the native-extended-gdbserver protocol.
This leaves one KFAIL when using the native-extended-gdbserver board,
we find the debug information but (apparently) find it in the wrong
file. What's happening is that when GDB builds the filename for the
debug information we end up with a '//' string as a directory
separator, the test regexp only expects a single separator.
Instead of just fixing the test regexp, I've updated the path_join
function in gdbsupport/pathstuff.{cc,h} to allow for absolute paths to
appear in the argument list after the first argument. This means it's
now possible to do this:
auto result = path_join ("/a/b/c", "/d/e/f");
gdb_assert (result == "/a/b/c/d/e/f");
Additionally I've changed path_join so that it avoids adding
unnecessary directory separators. In the above case when the two
paths were joined GDB only added a single separator between 'c' and
'd'. But additionally, if we did this:
auto result = path_join ("/a/b/c/", "/d/e/f");
gdb_assert (result == "/a/b/c/d/e/f");
We'd still only get a single separator.
With these changes to path_join I can now make use of this function in
find_separate_debug_file. With this done I now have no KFAIL when
using the native-extended-gdbserver board.
After this commit we still have 2 KFAIL when not using the
native-gdbserver and unix boards, these will be addressed in the next
commit.
Bug: https://sourceware.org/bugzilla/show_bug.cgi?id=31804
Reviewed-By: Keith Seitz <keiths@redhat.com>
184 lines
6.3 KiB
C++
184 lines
6.3 KiB
C++
/* Path manipulation routines for GDB and gdbserver.
|
|
|
|
Copyright (C) 1986-2024 Free Software Foundation, Inc.
|
|
|
|
This file is part of GDB.
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>. */
|
|
|
|
#ifndef COMMON_PATHSTUFF_H
|
|
#define COMMON_PATHSTUFF_H
|
|
|
|
#include "gdbsupport/byte-vector.h"
|
|
#include "gdbsupport/array-view.h"
|
|
|
|
#include <sys/types.h>
|
|
#include <sys/stat.h>
|
|
#include <unistd.h>
|
|
#include <array>
|
|
|
|
/* Path utilities. */
|
|
|
|
/* Return the real path of FILENAME, expanding all the symbolic links.
|
|
|
|
Contrary to "gdb_abspath", this function does not use
|
|
CURRENT_DIRECTORY for path expansion. Instead, it relies on the
|
|
current working directory (CWD) of GDB or gdbserver. */
|
|
|
|
extern gdb::unique_xmalloc_ptr<char> gdb_realpath (const char *filename);
|
|
|
|
/* Return a copy of FILENAME, with its directory prefix canonicalized
|
|
by gdb_realpath. */
|
|
|
|
extern std::string gdb_realpath_keepfile (const char *filename);
|
|
|
|
/* Return PATH in absolute form, performing tilde-expansion if necessary.
|
|
PATH cannot be NULL or the empty string.
|
|
This does not resolve symlinks however, use gdb_realpath for that.
|
|
|
|
Contrary to "gdb_realpath", this function uses CURRENT_DIRECTORY
|
|
for the path expansion. This may lead to scenarios the current
|
|
working directory (CWD) is different than CURRENT_DIRECTORY.
|
|
|
|
If CURRENT_DIRECTORY is NULL, this function returns a copy of
|
|
PATH. */
|
|
|
|
extern std::string gdb_abspath (const char *path);
|
|
|
|
/* Overload of gdb_abspath which takes std::string. */
|
|
|
|
static inline std::string
|
|
gdb_abspath (const std::string &path)
|
|
{
|
|
return gdb_abspath (path.c_str ());
|
|
}
|
|
|
|
/* Overload of gdb_abspath which takes gdb::unique_xmalloc_ptr<char>. */
|
|
|
|
static inline std::string
|
|
gdb_abspath (const gdb::unique_xmalloc_ptr<char> &path)
|
|
{
|
|
return gdb_abspath (path.get ());
|
|
}
|
|
|
|
/* If the path in CHILD is a child of the path in PARENT, return a
|
|
pointer to the first component in the CHILD's pathname below the
|
|
PARENT. Otherwise, return NULL. */
|
|
|
|
extern const char *child_path (const char *parent, const char *child);
|
|
|
|
/* Join elements in PATHS into a single path.
|
|
|
|
The first element can be absolute or relative. Only a single directory
|
|
separator will be placed between elements of PATHS, if one element ends
|
|
with a directory separator, or an element starts with a directory
|
|
separator, then these will be collapsed into a single separator. */
|
|
|
|
extern std::string path_join (gdb::array_view<const char *> paths);
|
|
|
|
/* Same as the above, but accept paths as distinct parameters. */
|
|
|
|
template<typename ...Args>
|
|
std::string
|
|
path_join (Args... paths)
|
|
{
|
|
/* It doesn't make sense to join less than two paths. */
|
|
static_assert (sizeof... (Args) >= 2);
|
|
|
|
std::array<const char *, sizeof... (Args)> path_array
|
|
{ paths... };
|
|
|
|
return path_join (gdb::array_view<const char *> (path_array));
|
|
}
|
|
|
|
/* Return whether PATH contains a directory separator character. */
|
|
|
|
extern bool contains_dir_separator (const char *path);
|
|
|
|
/* Get the usual user cache directory for the current platform.
|
|
|
|
On Linux, it follows the XDG Base Directory specification: use
|
|
$XDG_CACHE_HOME/gdb if the XDG_CACHE_HOME environment variable is
|
|
defined, otherwise $HOME/.cache.
|
|
|
|
On macOS, it follows the local convention and uses
|
|
~/Library/Caches/gdb.
|
|
|
|
The return value is absolute and tilde-expanded. Return an empty
|
|
string if neither XDG_CACHE_HOME (on Linux) or HOME are defined. */
|
|
|
|
extern std::string get_standard_cache_dir ();
|
|
|
|
/* Get the usual temporary directory for the current platform.
|
|
|
|
On Windows, this is the TMP or TEMP environment variable.
|
|
|
|
On the rest, this is the TMPDIR environment variable, if defined, else /tmp.
|
|
|
|
Throw an exception on error. */
|
|
|
|
extern std::string get_standard_temp_dir ();
|
|
|
|
/* Get the usual user config directory for the current platform.
|
|
|
|
On Linux, it follows the XDG Base Directory specification: use
|
|
$XDG_CONFIG_HOME/gdb if the XDG_CONFIG_HOME environment variable is
|
|
defined, otherwise $HOME/.config.
|
|
|
|
On macOS, it follows the local convention and uses
|
|
~/Library/Preferences/gdb.
|
|
|
|
The return value is absolute and tilde-expanded. Return an empty
|
|
string if neither XDG_CONFIG_HOME (on Linux) or HOME are defined. */
|
|
|
|
extern std::string get_standard_config_dir ();
|
|
|
|
/* Look for FILENAME in the standard configuration directory as returned by
|
|
GET_STANDARD_CONFIG_DIR and return the path to the file. No check is
|
|
performed that the file actually exists or not.
|
|
|
|
If FILENAME begins with a '.' then the path returned will remove the
|
|
leading '.' character, for example passing '.gdbinit' could return the
|
|
path '/home/username/.config/gdb/gdbinit'. */
|
|
|
|
extern std::string get_standard_config_filename (const char *filename);
|
|
|
|
/* Look for a file called NAME in either the standard config directory or
|
|
in the users home directory. If a suitable file is found then *BUF will
|
|
be filled with the contents of a call to 'stat' on the found file,
|
|
otherwise *BUF is undefined after this call.
|
|
|
|
If NAME starts with a '.' character then, when looking in the standard
|
|
config directory the file searched for has the '.' removed. For
|
|
example, if NAME is '.gdbinit' then on a Linux target GDB might look for
|
|
'~/.config/gdb/gdbinit' and then '~/.gdbinit'. */
|
|
|
|
extern std::string find_gdb_home_config_file (const char *name,
|
|
struct stat *buf);
|
|
|
|
/* Return the file name of the user's shell. Normally this comes from
|
|
the SHELL environment variable. */
|
|
|
|
extern const char *get_shell ();
|
|
|
|
/* Make a filename suitable to pass to mkstemp based on F (e.g.
|
|
/tmp/foo -> /tmp/foo-XXXXXX). */
|
|
|
|
extern gdb::char_vector make_temp_filename (const std::string &f);
|
|
|
|
/* String containing the current directory (what getwd would return). */
|
|
extern char *current_directory;
|
|
|
|
#endif /* COMMON_PATHSTUFF_H */
|