gdb/gdbserver: share x86/linux tdesc caching

This commit builds on the previous series of commits to share the
target description caching code between GDB and gdbserver for
x86/Linux targets.

The objective of this commit is to move the four functions (2 each of)
i386_linux_read_description and amd64_linux_read_description into the
gdb/arch/ directory and combine them so we have just a single copy of
each.  Then GDB, gdbserver, and the in-process-agent (IPA) will link
against these shared functions.

One curiosity with this patch is the function
x86_linux_post_init_tdesc.  On the gdbserver side the two functions
amd64_linux_read_description and i386_linux_read_description have some
functionality that is not present on the GDB side, there is some
additional configuration that is performed as each target description
is created, to setup the expedited registers.

To support this I've added the function x86_linux_post_init_tdesc.
This function is called from the two *_linux_read_description
functions, but is implemented separately for GDB and gdbserver.

An alternative approach that avoids adding x86_linux_post_init_tdesc
would be to have x86_linux_tdesc_for_tid return a non-const target
description, then in x86_target::low_arch_setup we could inspect the
target description to figure out if it is 64-bit or not, and modify
the target description as needed.  In the end I think that adding the
x86_linux_post_init_tdesc function is the simpler solution.

The contents of gdbserver/linux-x86-low.cc have moved to
gdb/arch/x86-linux-tdesc-features.c, and gdbserver/linux-x86-tdesc.h
has moved to gdb/arch/x86-linux-tdesc-features.h, this change leads to
some updates in the #includes in the gdbserver/ directory.

This commit also changes how target descriptions are cached.
Previously both GDB and gdbserver used static C-style arrays to act as
the tdesc cache.  This was fine, except for two problems.  Either the
C-style arrays would need to be placed in x86-linux-tdesc-features.c,
which would allow us to use the x86_linux_*_tdesc_count_1() functions
to size the arrays for us, or we'd need to hard code the array sizes
using separate #defines, which we'd then have to keep in sync with the
rest of the code in x86-linux-tdesc-features.c.

Given both of these problems I decided a better solution would be to
just switch to using a std::unordered_map to act as the cache.  This
will resize automatically, and we can use the xcr0 value as the key.

At first inspection, using xcr0 might seem to be a problem; after all
the {i386,amd64}_create_target_description functions take more than
just the xcr0 value.  However, this patch is only for x86/Linux
targets, and for x86/Linux all of the other flags passed to the tdesc
creation functions have constant values and so are irrelevant when we
consider tdesc caching.

For testing I've done the following:

  - Built on x86-64 GNU/Linux for all targets, and just for the native
    target,

  - Build on i386 GNU/Linux for all targets, and just for the native
    target,

  - Build on a 64-bit, non-x86 GNU/Linux for all targets, just for the
    native target, and for targets x86_64-*-linux and i386-*-linux.

Approved-By: Felix Willgerodt <felix.willgerodt@intel.com>

1 files changed, 267 insertions, 0 deletions

diff --git a/gdb/arch/x86-linux-tdesc-features.c b/gdb/arch/x86-linux-tdesc-features.c
new file mode 100644
index 0000000..ad1d919
--- /dev/null
+++ b/gdb/arch/x86-linux-tdesc-features.c
@@ -0,0 +1,267 @@
+/* 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 "arch/x86-linux-tdesc-features.h"
+
+/* A structure used to describe a single xstate feature bit that might, or
+   might not, be checked for when creating a target description for one of
+   i386, amd64, or x32.
+
+   The different CPU/ABI types check for different xstate features when
+   creating a target description.
+
+   We want to cache target descriptions, and this is currently done in
+   three separate caches, one each for i386, amd64, and x32.  Additionally,
+   the caching we're discussing here is Linux only, and for Linux, the only
+   thing that has an impact on target description creation is the xcr0
+   value.
+
+   In order to ensure the cache functions correctly we need to filter out
+   only those xcr0 feature bits that are relevant, we can then cache target
+   descriptions based on the relevant feature bits.  Two xcr0 values might
+   be different, but have the same relevant feature bits.  In this case we
+   would expect the two xcr0 values to map to the same cache entry.  */
+
+struct x86_xstate_feature {
+  /* The xstate feature mask.  This is a mask against an xcr0 value.  */
+  uint64_t feature;
+
+  /* Is this feature checked when creating an i386 target description.  */
+  bool is_i386;
+
+  /* Is this feature checked when creating an amd64 target description.  */
+  bool is_amd64;
+
+  /* Is this feature checked when creating an x32 target description.  */
+  bool is_x32;
+};
+
+/* A constant table that describes all of the xstate features that are
+   checked when building a target description for i386, amd64, or x32.
+
+   If in the future, due to simplifications or refactoring, this table ever
+   ends up with 'true' for every xcr0 feature on every target type, then this
+   is an indication that this table should probably be removed, and that the
+   rest of the code in this file can be simplified.  */
+
+static constexpr x86_xstate_feature x86_linux_all_xstate_features[] = {
+  /* Feature,           i386,	amd64,	x32.  */
+  { X86_XSTATE_PKRU,	true,	true, 	true },
+  { X86_XSTATE_AVX512,	true,	true, 	true },
+  { X86_XSTATE_AVX,	true,	true, 	true },
+  { X86_XSTATE_MPX,	true,	true, 	false },
+  { X86_XSTATE_SSE,	true,	false, 	false },
+  { X86_XSTATE_X87,	true,	false, 	false }
+};
+
+/* Return a compile time constant which is a mask of all the xstate features
+   that are checked for when building an i386 target description.  */
+
+static constexpr uint64_t
+x86_linux_i386_xcr0_feature_mask_1 ()
+{
+  uint64_t mask = 0;
+
+  for (const auto &entry : x86_linux_all_xstate_features)
+    if (entry.is_i386)
+      mask |= entry.feature;
+
+  return mask;
+}
+
+/* Return a compile time constant which is a mask of all the xstate features
+   that are checked for when building an amd64 target description.  */
+
+static constexpr uint64_t
+x86_linux_amd64_xcr0_feature_mask_1 ()
+{
+  uint64_t mask = 0;
+
+  for (const auto &entry : x86_linux_all_xstate_features)
+    if (entry.is_amd64)
+      mask |= entry.feature;
+
+  return mask;
+}
+
+/* Return a compile time constant which is a mask of all the xstate features
+   that are checked for when building an x32 target description.  */
+
+static constexpr uint64_t
+x86_linux_x32_xcr0_feature_mask_1 ()
+{
+  uint64_t mask = 0;
+
+  for (const auto &entry : x86_linux_all_xstate_features)
+    if (entry.is_x32)
+      mask |= entry.feature;
+
+  return mask;
+}
+
+/* See arch/x86-linux-tdesc-features.h.  */
+
+uint64_t
+x86_linux_i386_xcr0_feature_mask ()
+{
+  return x86_linux_i386_xcr0_feature_mask_1 ();
+}
+
+/* See arch/x86-linux-tdesc-features.h.  */
+
+uint64_t
+x86_linux_amd64_xcr0_feature_mask ()
+{
+  return x86_linux_amd64_xcr0_feature_mask_1 ();
+}
+
+/* See arch/x86-linux-tdesc-features.h.  */
+
+uint64_t
+x86_linux_x32_xcr0_feature_mask ()
+{
+  return x86_linux_x32_xcr0_feature_mask_1 ();
+}
+
+#ifdef GDBSERVER
+
+/* See arch/x86-linux-tdesc-features.h.  */
+
+int
+x86_linux_xcr0_to_tdesc_idx (uint64_t xcr0)
+{
+  /* The following table shows which features are checked for when creating
+     the target descriptions (see nat/x86-linux-tdesc.c), the feature order
+     represents the bit order within the generated index number.
+
+     i386  | x87 sse mpx avx avx512 pkru
+     amd64 |         mpx avx avx512 pkru
+     i32   |             avx avx512 pkru
+
+     The features are ordered so that for each mode (i386, amd64, i32) the
+     generated index will form a continuous range.  */
+
+  int idx = 0;
+
+  for (int i = 0; i < ARRAY_SIZE (x86_linux_all_xstate_features); ++i)
+    {
+      if ((xcr0 & x86_linux_all_xstate_features[i].feature)
+	  == x86_linux_all_xstate_features[i].feature)
+	idx |= (1 << i);
+    }
+
+  return idx;
+}
+
+#endif /* GDBSERVER */
+
+#ifdef IN_PROCESS_AGENT
+
+/* Return a compile time constant which is a count of the number of xstate
+   features that are checked for when building an i386 target description.  */
+
+static constexpr int
+x86_linux_i386_tdesc_count_1 ()
+{
+  uint64_t count = 0;
+
+  for (const auto &entry : x86_linux_all_xstate_features)
+    if (entry.is_i386)
+      ++count;
+
+  gdb_assert (count > 0);
+
+  return (1 << count);
+}
+
+/* Return a compile time constant which is a count of the number of xstate
+   features that are checked for when building an amd64 target description.  */
+
+static constexpr int
+x86_linux_amd64_tdesc_count_1 ()
+{
+  uint64_t count = 0;
+
+  for (const auto &entry : x86_linux_all_xstate_features)
+    if (entry.is_amd64)
+      ++count;
+
+  gdb_assert (count > 0);
+
+  return (1 << count);
+}
+
+/* Return a compile time constant which is a count of the number of xstate
+   features that are checked for when building an x32 target description.  */
+
+static constexpr int
+x86_linux_x32_tdesc_count_1 ()
+{
+  uint64_t count = 0;
+
+  for (const auto &entry : x86_linux_all_xstate_features)
+    if (entry.is_x32)
+      ++count;
+
+  gdb_assert (count > 0);
+
+  return (1 << count);
+}
+
+/* See arch/x86-linux-tdesc-features.h.  */
+
+int
+x86_linux_amd64_tdesc_count ()
+{
+  return x86_linux_amd64_tdesc_count_1 ();
+}
+
+/* See arch/x86-linux-tdesc-features.h.  */
+
+int
+x86_linux_x32_tdesc_count ()
+{
+  return x86_linux_x32_tdesc_count_1 ();
+}
+
+/* See arch/x86-linux-tdesc-features.h.  */
+
+int
+x86_linux_i386_tdesc_count ()
+{
+  return x86_linux_i386_tdesc_count_1 ();
+}
+
+/* See arch/x86-linux-tdesc-features.h.  */
+
+uint64_t
+x86_linux_tdesc_idx_to_xcr0 (int idx)
+{
+  uint64_t xcr0 = 0;
+
+  for (int i = 0; i < ARRAY_SIZE (x86_linux_all_xstate_features); ++i)
+    {
+      if ((idx & (1 << i)) != 0)
+	xcr0 |= x86_linux_all_xstate_features[i].feature;
+    }
+
+  return xcr0;
+}
+
+#endif /* IN_PROCESS_AGENT */