Mask x86 segment registers in Windows gdbserver

Message ID 20231219144823.1070597-1-tromey@adacore.com
State New
Headers
Series Mask x86 segment registers in Windows gdbserver |

Checks

Context Check Description
linaro-tcwg-bot/tcwg_gdb_build--master-aarch64 success Testing passed
linaro-tcwg-bot/tcwg_gdb_build--master-arm success Testing passed
linaro-tcwg-bot/tcwg_gdb_check--master-arm success Testing passed
linaro-tcwg-bot/tcwg_gdb_check--master-aarch64 success Testing passed

Commit Message

Tom Tromey Dec. 19, 2023, 2:48 p.m. UTC
  A test internal to AdaCore prints the segment registers.  When run
using gdbserver, it shows:

    (gdb) print /x $gs
    $6 = 0x2b0000

However, the segment registers are only 16 bits -- so this has some
invalid bits.

gdb's windows-nat.c has long had a fix for this problem.  This patch
applies the fix to gdbserver as well.
---
 gdbserver/win32-i386-low.cc | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
  

Comments

John Baldwin Dec. 20, 2023, 10:03 p.m. UTC | #1
On 12/19/23 6:48 AM, Tom Tromey wrote:
> A test internal to AdaCore prints the segment registers.  When run
> using gdbserver, it shows:
> 
>      (gdb) print /x $gs
>      $6 = 0x2b0000
> 
> However, the segment registers are only 16 bits -- so this has some
> invalid bits.
> 
> gdb's windows-nat.c has long had a fix for this problem.  This patch
> applies the fix to gdbserver as well.

LGTM.  Treating the x86 seg regs as 32-bits has required workarounds in
various places, but not easily fixable unfortunately.

Reviewed-By: John Baldwin <jhb@FreeBSD.org>
  
Tom Tromey Dec. 21, 2023, 8:29 p.m. UTC | #2
>> A test internal to AdaCore prints the segment registers.  When run
>> using gdbserver, it shows:
>> (gdb) print /x $gs
>> $6 = 0x2b0000
>> However, the segment registers are only 16 bits -- so this has some
>> invalid bits.
>> gdb's windows-nat.c has long had a fix for this problem.  This patch
>> applies the fix to gdbserver as well.

John> LGTM.  Treating the x86 seg regs as 32-bits has required workarounds in
John> various places, but not easily fixable unfortunately.

Well, to my surprise, this patch caused regressions in our internal
tester.

It works again if I explicitly exclude the 'ss' register, like:

  if (!windows_process.wow64_process)
    return r >= AMD64_CS_REGNUM && r <= AMD64_GS_REGNUM && r != 19;

Now, this seems "ok" to do in some sense.  However, I can't explain why
native gdb works fine, as it has the same logic in
amd64_windows_segment_register_p.

I'd welcome any thoughts you (or anybody) might have.

Tom
  
Tom Tromey Jan. 18, 2024, 6:51 p.m. UTC | #3
John> LGTM.  Treating the x86 seg regs as 32-bits has required workarounds in
John> various places, but not easily fixable unfortunately.

Tom> Well, to my surprise, this patch caused regressions in our internal
Tom> tester.

Tom> It works again if I explicitly exclude the 'ss' register, like:

Tom>   if (!windows_process.wow64_process)
Tom>     return r >= AMD64_CS_REGNUM && r <= AMD64_GS_REGNUM && r != 19;

Tom> Now, this seems "ok" to do in some sense.  However, I can't explain why
Tom> native gdb works fine, as it has the same logic in
Tom> amd64_windows_segment_register_p.

Tom> I'd welcome any thoughts you (or anybody) might have.

I finally figured it out.  The Windows CONTEXT structure uses 16-bit
types for these registers' fields.  So, gdbserver is actually
reading/writing past the end of the field here.

My patch correctly truncates the value, but the truncated value is
preserved and written back -- overwriting other fields in the thread
context.

I have a new patch that fixes this problem and some other related things
as well.  I'll send it once it's been through a bit more testing.

Tom
  
John Baldwin Jan. 22, 2024, 4:57 p.m. UTC | #4
On 1/18/24 10:51 AM, Tom Tromey wrote:
> John> LGTM.  Treating the x86 seg regs as 32-bits has required workarounds in
> John> various places, but not easily fixable unfortunately.
> 
> Tom> Well, to my surprise, this patch caused regressions in our internal
> Tom> tester.
> 
> Tom> It works again if I explicitly exclude the 'ss' register, like:
> 
> Tom>   if (!windows_process.wow64_process)
> Tom>     return r >= AMD64_CS_REGNUM && r <= AMD64_GS_REGNUM && r != 19;
> 
> Tom> Now, this seems "ok" to do in some sense.  However, I can't explain why
> Tom> native gdb works fine, as it has the same logic in
> Tom> amd64_windows_segment_register_p.
> 
> Tom> I'd welcome any thoughts you (or anybody) might have.
> 
> I finally figured it out.  The Windows CONTEXT structure uses 16-bit
> types for these registers' fields.  So, gdbserver is actually
> reading/writing past the end of the field here.
> 
> My patch correctly truncates the value, but the truncated value is
> preserved and written back -- overwriting other fields in the thread
> context.
> 
> I have a new patch that fixes this problem and some other related things
> as well.  I'll send it once it's been through a bit more testing.

Ouch, good find.
  

Patch

diff --git a/gdbserver/win32-i386-low.cc b/gdbserver/win32-i386-low.cc
index f78e0120678..d60ff83c15d 100644
--- a/gdbserver/win32-i386-low.cc
+++ b/gdbserver/win32-i386-low.cc
@@ -35,6 +35,12 @@  using namespace windows_nat;
 #define FCS_REGNUM 27
 #define FOP_REGNUM 31
 
+#define I386_CS_REGNUM 10
+#define I386_GS_REGNUM 15
+
+#define AMD64_CS_REGNUM 18
+#define AMD64_GS_REGNUM 23
+
 #define FLAG_TRACE_BIT 0x100
 
 static struct x86_debug_reg_state debug_reg_state;
@@ -459,6 +465,18 @@  static const int amd64_mappings[] =
 
 #endif /* __x86_64__ */
 
+/* Return true if R is a segment register.  */
+static bool
+is_segment_register (int r)
+{
+#ifdef __x86_64__
+  if (!windows_process.wow64_process)
+    return r >= AMD64_CS_REGNUM && r <= AMD64_GS_REGNUM;
+  else
+#endif
+    return r >= I386_CS_REGNUM && r <= I386_GS_REGNUM;
+}
+
 /* Fetch register from gdbserver regcache data.  */
 static void
 i386_fetch_inferior_register (struct regcache *regcache,
@@ -491,6 +509,14 @@  i386_fetch_inferior_register (struct regcache *regcache,
       l = (*((long *) context_offset) >> 16) & ((1 << 11) - 1);
       supply_register (regcache, r, (char *) &l);
     }
+  else if (is_segment_register (r))
+    {
+      /* GDB treats segment registers as 32bit registers, but they are
+	 in fact only 16 bits long.  Make sure we do not read extra
+	 bits from our source buffer.  */
+      l = *((long *) context_offset) & 0xffff;
+      supply_register (regcache, r, (char *) &l);
+    }
   else
     supply_register (regcache, r, context_offset);
 }