gdb/gdbserver: share some code relating to target description creation

This commit is part of a series to share more of the x86 target
description creation code between GDB and gdbserver.

Unlike previous commits which were mostly refactoring, this commit is
the first that makes a real change, though that change should mostly
be for gdbserver; I've largely adopted the "GDB" way of doing things
for gdbserver, and this fixes a real gdbserver bug.

On a x86-64 Linux target, running the test:

  gdb.server/connect-with-no-symbol-file.exp

results in two core files being created.  Both of these core files are
from the inferior process, created after gdbserver has detached.

In this test a gdbserver process is started and then, after gdbserver
has started, but before GDB attaches, we either delete the inferior
executable, or change its permissions so it can't be read.  Only after
doing this do we attempt to connect with GDB.

As GDB connects to gdbserver, gdbserver attempts to figure out the
target description so that it can send the description to GDB, this
involves a call to x86_linux_read_description.

In x86_linux_read_description one of the first things we do is try to
figure out if the process is 32-bit or 64-bit.  To do this we look up
the executable via the thread-id, and then attempt to read the
architecture size from the executable.  This isn't going to work if
the executable has been deleted, or is no longer readable.

And so, as we can't read the executable, we default to an i386 target
and use an i386 target description.

A consequence of using an i386 target description is that addresses
are assumed to be 32-bits.  Here's an example session that shows the
problems this causes.  This is run on an x86-64 machine, and the test
binary (xx.x) is a standard 64-bit x86-64 binary:

  shell_1$ gdbserver --once localhost :54321 /tmp/xx.x

  shell_2$ gdb -q
  (gdb) set sysroot
  (gdb) shell chmod 000 /tmp/xx.x
  (gdb) target remote :54321
  Remote debugging using :54321
  warning: /tmp/xx.x: Permission denied.
  0xf7fd3110 in ?? ()
  (gdb) show architecture
  The target architecture is set to "auto" (currently "i386").
  (gdb) p/x $pc
  $1 = 0xf7fd3110
  (gdb) info proc mappings
  process 2412639
  Mapped address spaces:

  	Start Addr   End Addr       Size     Offset  Perms   objfile
  	  0x400000   0x401000     0x1000        0x0  r--p   /tmp/xx.x
  	  0x401000   0x402000     0x1000     0x1000  r-xp   /tmp/xx.x
  	  0x402000   0x403000     0x1000     0x2000  r--p   /tmp/xx.x
  	  0x403000   0x405000     0x2000     0x2000  rw-p   /tmp/xx.x
  	0xf7fcb000 0xf7fcf000     0x4000        0x0  r--p   [vvar]
  	0xf7fcf000 0xf7fd1000     0x2000        0x0  r-xp   [vdso]
  	0xf7fd1000 0xf7fd3000     0x2000        0x0  r--p   /usr/lib64/ld-2.30.so
  	0xf7fd3000 0xf7ff3000    0x20000     0x2000  r-xp   /usr/lib64/ld-2.30.so
  	0xf7ff3000 0xf7ffb000     0x8000    0x22000  r--p   /usr/lib64/ld-2.30.so
  	0xf7ffc000 0xf7ffe000     0x2000    0x2a000  rw-p   /usr/lib64/ld-2.30.so
  	0xf7ffe000 0xf7fff000     0x1000        0x0  rw-p
  	0xfffda000 0xfffff000    0x25000        0x0  rw-p   [stack]
  	0xff600000 0xff601000     0x1000        0x0  r-xp   [vsyscall]
  (gdb) info inferiors
    Num  Description       Connection           Executable
  * 1    process 2412639   1 (remote :54321)
  (gdb) shell cat /proc/2412639/maps
  00400000-00401000 r--p 00000000 fd:03 45907133           /tmp/xx.x
  00401000-00402000 r-xp 00001000 fd:03 45907133           /tmp/xx.x
  00402000-00403000 r--p 00002000 fd:03 45907133           /tmp/xx.x
  00403000-00405000 rw-p 00002000 fd:03 45907133           /tmp/xx.x
  7ffff7fcb000-7ffff7fcf000 r--p 00000000 00:00 0          [vvar]
  7ffff7fcf000-7ffff7fd1000 r-xp 00000000 00:00 0          [vdso]
  7ffff7fd1000-7ffff7fd3000 r--p 00000000 fd:00 143904     /usr/lib64/ld-2.30.so
  7ffff7fd3000-7ffff7ff3000 r-xp 00002000 fd:00 143904     /usr/lib64/ld-2.30.so
  7ffff7ff3000-7ffff7ffb000 r--p 00022000 fd:00 143904     /usr/lib64/ld-2.30.so
  7ffff7ffc000-7ffff7ffe000 rw-p 0002a000 fd:00 143904     /usr/lib64/ld-2.30.so
  7ffff7ffe000-7ffff7fff000 rw-p 00000000 00:00 0
  7ffffffda000-7ffffffff000 rw-p 00000000 00:00 0          [stack]
  ffffffffff600000-ffffffffff601000 r-xp 00000000 00:00 0  [vsyscall]
  (gdb)

Notice the difference between the mappings reported via GDB and those
reported directly from the kernel via /proc/PID/maps, the addresses of
every mapping is clamped to 32-bits for GDB, while the kernel reports
real 64-bit addresses.

Notice also that the $pc value is a 32-bit value.  It appears to be
within one of the mappings reported by GDB, but is outside any of the
mappings reported from the kernel.

And this is where the problem arises.  When gdbserver detaches from
the inferior we pass the inferior the address from which it should
resume.  Due to the 32/64 bit confusion we tell the inferior to resume
from the 32-bit $pc value, which is not within any valid mapping, and
so, as soon as the inferior resumes, it segfaults.

If we look at how GDB (not gdbserver) figures out its target
description then we see an interesting difference.  GDB doesn't try to
read the executable.  Instead GDB uses ptrace to query the thread's
state, and uses this to figure out the if the thread is 32 or 64 bit.

If we update gdbserver to do it the "GDB" way then the above problem
is resolved, gdbserver now sees the process as 64-bit, and when we
detach from the inferior we give it the correct 64-bit address, and
the inferior no longer segfaults.

Now, I could just update the gdbserver code, but better, I think, to
share one copy of the code between GDB and gdbserver in gdb/nat/.
That is what this commit does.

The cores of x86_linux_read_description from gdbserver and
x86_linux_nat_target::read_description from GDB are moved into a new
file gdb/nat/x86-linux-tdesc.c and combined into a single function
x86_linux_tdesc_for_tid which is called from each location.

This new function does things the GDB way, the only changes are to
allow for the sharing; we now have a callback function to call the
first time that the xcr0 state is read, this allows for GDB and
gdbserver to perform their own initialisation as needed, and
additionally, the new function takes a pointer for where to cache the
xcr0 value, this isn't needed for this commit, but will be useful in a
later commit where gdbserver will want to read this cached xcr0
value.

Another thing to note about this commit is how the functions
i386_linux_read_description and amd64_linux_read_description are
handled.  For now I've left these function as implemented separately
in GDB and gdbserver.  I've moved the declarations of these functions
into gdb/nat/x86-linux-tdesc.h, but the implementations are left as
separate.

A later commit in this series will make these functions shared too,
but doing this is not trivial, so I've left that for a separate
commit.  Merging the declarations as I've done here ensures that
everyone implements the function to the same API, and once these
functions are shared (in a later commit) we'll want a shared
declaration anyway.

Approved-By: John Baldwin <jhb@FreeBSD.org>

2 files changed, 199 insertions, 0 deletions

diff --git a/gdb/nat/x86-linux-tdesc.c b/gdb/nat/x86-linux-tdesc.c
new file mode 100644
index 0000000..be7014d
--- /dev/null
+++ b/gdb/nat/x86-linux-tdesc.c
@@ -0,0 +1,124 @@
+/* Target description related code for GNU/Linux x86 (i386 and x86-64).
+
+   Copyright (C) 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/>.  */
+
+#include "gdbsupport/common-defs.h"
+#include "nat/x86-linux-tdesc.h"
+#ifdef __x86_64__
+#include "arch/amd64.h"
+#endif
+#include "arch/i386.h"
+
+#include "gdbsupport/common-defs.h"
+#include "nat/x86-linux.h"
+#include "nat/x86-linux-dregs.h"
+#include "nat/gdb_ptrace.h"
+#include "nat/x86-xstate.h"
+#include "nat/x86-linux-tdesc.h"
+
+#include <cstdint>
+#include <cstdlib>
+#include <linux/uio.h>
+#include <elf.h>
+#include <sys/user.h>
+#include <sys/user.h>
+
+/* See nat/x86-linux-tdesc.h.  */
+
+const target_desc *
+x86_linux_tdesc_for_tid (int tid, enum tribool *have_ptrace_getregset,
+			 gdb::function_view<void (uint64_t)> xcr0_init_cb,
+			 const char *error_msg, uint64_t *xcr0_storage)
+{
+#ifdef __x86_64__
+
+  x86_linux_arch_size arch_size = x86_linux_ptrace_get_arch_size (tid);
+  bool is_64bit = arch_size.is_64bit ();
+  bool is_x32 = arch_size.is_x32 ();
+
+  if (sizeof (void *) == 4 && is_64bit && !is_x32)
+    error ("%s", error_msg);
+
+#elif HAVE_PTRACE_GETFPXREGS
+  if (have_ptrace_getfpxregs == -1)
+    {
+      elf_fpxregset_t fpxregs;
+
+      if (ptrace (PTRACE_GETFPXREGS, tid, 0, (int) &fpxregs) < 0)
+	{
+	  have_ptrace_getfpxregs = 0;
+	  *have_ptrace_getregset = TRIBOOL_FALSE;
+	  return i386_linux_read_description (X86_XSTATE_X87_MASK);
+	}
+    }
+#endif
+
+  if (*have_ptrace_getregset == TRIBOOL_UNKNOWN)
+    {
+      uint64_t xstateregs[(X86_XSTATE_SSE_SIZE / sizeof (uint64_t))];
+      struct iovec iov;
+
+      iov.iov_base = xstateregs;
+      iov.iov_len = sizeof (xstateregs);
+
+      /* Check if PTRACE_GETREGSET works.  */
+      if (ptrace (PTRACE_GETREGSET, tid,
+		  (unsigned int) NT_X86_XSTATE, &iov) < 0)
+	{
+	  *have_ptrace_getregset = TRIBOOL_FALSE;
+	  *xcr0_storage = 0;
+	}
+      else
+	{
+	  *have_ptrace_getregset = TRIBOOL_TRUE;
+
+	  /* Get XCR0 from XSAVE extended state.  */
+	  *xcr0_storage = xstateregs[(I386_LINUX_XSAVE_XCR0_OFFSET
+				      / sizeof (uint64_t))];
+
+#ifdef __x86_64__
+	  /* No MPX on x32.  */
+	  if (is_64bit && is_x32)
+	    *xcr0_storage &= ~X86_XSTATE_MPX;
+#endif /* __x86_64__ */
+
+	  xcr0_init_cb (*xcr0_storage);
+	}
+    }
+
+  /* Check the native XCR0 only if PTRACE_GETREGSET is available.  If
+     PTRACE_GETREGSET is not available then set xcr0_features_bits to
+     zero so that the "no-features" descriptions are returned by the
+     switches below.  */
+  uint64_t xcr0_features_bits;
+  if (*have_ptrace_getregset == TRIBOOL_TRUE)
+    xcr0_features_bits = *xcr0_storage & X86_XSTATE_ALL_MASK;
+  else
+    xcr0_features_bits = 0;
+
+#ifdef __x86_64__
+  if (is_64bit)
+    {
+      return amd64_linux_read_description (xcr0_features_bits, is_x32);
+    }
+  else
+#endif
+    return i386_linux_read_description (xcr0_features_bits);
+
+  gdb_assert_not_reached ("failed to return tdesc");
+}
diff --git a/gdb/nat/x86-linux-tdesc.h b/gdb/nat/x86-linux-tdesc.h
new file mode 100644
index 0000000..3727a8b
--- /dev/null
+++ b/gdb/nat/x86-linux-tdesc.h
@@ -0,0 +1,75 @@
+/* Target description related code for GNU/Linux x86 (i386 and x86-64).
+
+   Copyright (C) 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 NAT_X86_LINUX_TDESC_H
+#define NAT_X86_LINUX_TDESC_H
+
+#include "gdbsupport/function-view.h"
+
+struct target_desc;
+
+/* Return the target description for Linux thread TID.
+
+   When *HAVE_PTRACE_GETREGSET is TRIBOOL_UNKNOWN then the current value of
+   xcr0 is read using ptrace calls and stored into *XCR0_STORAGE.  Then
+   XCR0_INIT_CB is called with the value of *XCR0_STORAGE and
+   *HAVE_PTRACE_GETREGSET is set to TRIBOOL_TRUE.
+
+   If the attempt to read xcr0 using ptrace fails then *XCR0_STORAGE is set
+   to zero and *HAVE_PTRACE_GETREGSET is set to TRIBOOL_FALSE.
+
+   The storage pointed to by XCR0_STORAGE must exist until the program
+   terminates, this storage is used to cache the xcr0 value.  As such
+   XCR0_INIT_CB will only be called once if xcr0 is successfully read using
+   ptrace, or not at all if the ptrace call fails.
+
+   This function returns a target description based on the extracted xcr0
+   value along with other characteristics of the thread identified by TID.
+
+   This function can return nullptr if we encounter a machine configuration
+   for which a target_desc cannot be created.  Ideally this would not be
+   the case, we should be able to create a target description for every
+   possible machine configuration.  See amd64_linux_read_description and
+   i386_linux_read_description for cases when nullptr might be
+   returned.
+
+   ERROR_MSG is using in an error() call if we try to create a target
+   description for a 64-bit process but this is a 32-bit build of GDB.  */
+
+extern const target_desc *
+x86_linux_tdesc_for_tid (int tid, enum tribool *have_ptrace_getregset,
+			 gdb::function_view<void (uint64_t)> xcr0_init_cb,
+			 const char *error_msg, uint64_t *xcr0_storage);
+
+#ifdef __x86_64__
+
+/* Return the right amd64-linux target descriptions according to
+   XCR0_FEATURES_BIT and IS_X32.  This is implemented separately in both
+   GDB and gdbserver.  */
+
+extern const target_desc *amd64_linux_read_description
+	(uint64_t xcr0_features_bit, bool is_x32);
+
+#endif
+
+/* Return the target description according to XCR0.  This is implemented
+   separately in both GDB and gdbserver.  */
+extern const struct target_desc *i386_linux_read_description (uint64_t xcr0);
+
+#endif /* NAT_X86_LINUX_TDESC_H */