/* Target-dependent code for GNU/Linux x86.

   Copyright (C) 2002-2026 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 GDB_I386_LINUX_TDEP_H
#define GDB_I386_LINUX_TDEP_H

#include "gdbsupport/x86-xstate.h"
#include "i386-tdep.h"

/* Additional register numbers for i386 Linux, these are in addition to
   the register numbers found in 'enum i386_regnum', see i386-tdep.h.  */

enum i386_linux_regnum
{
  /* STOP!  The values in this enum are numbered after the values in the
     enum i386_regnum.  New entries should be placed after the ORIG_EAX
     entry.  */

  /* Register number for the "orig_eax" pseudo-register.  GDB needs access
     to this register to be able to properly restart system calls when
     necessary (see i386-linux-tdep.c).  If this pseudo-register contains a
     value >= 0 it is interpreted as the system call number that the kernel
     is supposed to restart.  */
  I386_LINUX_ORIG_EAX_REGNUM = I386_NUM_REGS,

  /* Register numbers for the three TLS GDT registers.  These contain the
     'struct user_desc' (see 'man 2 get_thread_area') values for the three
     TLS related Global Descriptor Table entries.  */
  I386_LINUX_TLS_GDT_0,
  I386_LINUX_TLS_GDT_1,
  I386_LINUX_TLS_GDT_2,

  /* Total number of registers for GNU/Linux.  */
  I386_LINUX_NUM_REGS

  /* STOP! Add new entries before I386_LINUX_NUM_REGS.  */
};

/* Read the XSAVE extended state xcr0 value from the ABFD core file.
   If it appears to be valid, return it and fill LAYOUT with values
   inferred from that value.

   Otherwise, return 0 to indicate no state was found and leave LAYOUT
   untouched.  */
extern uint64_t i386_linux_core_read_xsave_info (bfd *abfd,
						 x86_xsave_layout &layout);

/* Implement the core_read_x86_xsave_layout gdbarch method.  */
extern bool i386_linux_core_read_x86_xsave_layout (struct gdbarch *gdbarch,
						   bfd &cbfd,
						   x86_xsave_layout &layout);

extern int i386_linux_gregset_reg_offset[];

/* Return true if REGNUM is one of the 3 tls gdt registers.  */

static inline bool
i386_is_tls_regnum_p (int regnum)
{
  return regnum >= I386_LINUX_TLS_GDT_0 && regnum <= I386_LINUX_TLS_GDT_2;
}

#endif /* GDB_I386_LINUX_TDEP_H */
