binutils-gdb/gdb/xtensa-linux-nat.c
Andrew Burgess 08106042d9 gdb: move the type cast into gdbarch_tdep
I built GDB for all targets on a x86-64/GNU-Linux system, and
then (accidentally) passed GDB a RISC-V binary, and asked GDB to "run"
the binary on the native target.  I got this error:

  (gdb) show architecture
  The target architecture is set to "auto" (currently "i386").
  (gdb) file /tmp/hello.rv32.exe
  Reading symbols from /tmp/hello.rv32.exe...
  (gdb) show architecture
  The target architecture is set to "auto" (currently "riscv:rv32").
  (gdb) run
  Starting program: /tmp/hello.rv32.exe
  ../../src/gdb/i387-tdep.c:596: internal-error: i387_supply_fxsave: Assertion `tdep->st0_regnum >= I386_ST0_REGNUM' failed.

What's going on here is this; initially the architecture is i386, this
is based on the default architecture, which is set based on the native
target.  After loading the RISC-V executable the architecture of the
current inferior is updated based on the architecture of the
executable.

When we "run", GDB does a fork & exec, with the inferior being
controlled through ptrace.  GDB sees an initial stop from the inferior
as soon as the inferior comes to life.  In response to this stop GDB
ends up calling save_stop_reason (linux-nat.c), which ends up trying
to read register from the inferior, to do this we end up calling
target_ops::fetch_registers, which, for the x86-64 native target,
calls amd64_linux_nat_target::fetch_registers.

After this I eventually end up in i387_supply_fxsave, different x86
based targets will end in different functions to fetch registers, but
it doesn't really matter which function we end up in, the problem is
this line, which is repeated in many places:

  i386_gdbarch_tdep *tdep = (i386_gdbarch_tdep *) gdbarch_tdep (arch);

The problem here is that the ARCH in this line comes from the current
inferior, which, as we discussed above, will be a RISC-V gdbarch, the
tdep field will actually be of type riscv_gdbarch_tdep, not
i386_gdbarch_tdep.  After this cast we are relying on undefined
behaviour, in my case I happen to trigger an assert, but this might
not always be the case.

The thing I tried that exposed this problem was of course, trying to
start an executable of the wrong architecture on a native target.  I
don't think that the correct solution for this problem is to detect,
at the point of cast, that the gdbarch_tdep object is of the wrong
type, but, I did wonder, is there a way that we could protect
ourselves from incorrectly casting the gdbarch_tdep object?

I think that there is something we can do here, and this commit is the
first step in that direction, though no actual check is added by this
commit.

This commit can be split into two parts:

 (1) In gdbarch.h and arch-utils.c.  In these files I have modified
 gdbarch_tdep (the function) so that it now takes a template argument,
 like this:

    template<typename TDepType>
    static inline TDepType *
    gdbarch_tdep (struct gdbarch *gdbarch)
    {
      struct gdbarch_tdep *tdep = gdbarch_tdep_1 (gdbarch);
      return static_cast<TDepType *> (tdep);
    }

  After this change we are no better protected, but the cast is now
  done within the gdbarch_tdep function rather than at the call sites,
  this leads to the second, much larger change in this commit,

  (2) Everywhere gdbarch_tdep is called, we make changes like this:

    -  i386_gdbarch_tdep *tdep = (i386_gdbarch_tdep *) gdbarch_tdep (arch);
    +  i386_gdbarch_tdep *tdep = gdbarch_tdep<i386_gdbarch_tdep> (arch);

There should be no functional change after this commit.

In the next commit I will build on this change to add an assertion in
gdbarch_tdep that checks we are casting to the correct type.
2022-07-21 15:19:42 +01:00

351 lines
10 KiB
C

/* Xtensa GNU/Linux native support.
Copyright (C) 2007-2022 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 "defs.h"
#include "frame.h"
#include "inferior.h"
#include "gdbcore.h"
#include "regcache.h"
#include "target.h"
#include "linux-nat.h"
#include <sys/types.h>
#include <signal.h>
#include <sys/user.h>
#include <sys/ioctl.h>
#include "gdbsupport/gdb_wait.h"
#include <fcntl.h>
#include <sys/procfs.h>
#include "nat/gdb_ptrace.h"
#include <asm/ptrace.h>
#include "gregset.h"
#include "xtensa-tdep.h"
/* Defines ps_err_e, struct ps_prochandle. */
#include "gdb_proc_service.h"
/* Extended register set depends on hardware configs.
Keeping these definitions separately allows to introduce
hardware-specific overlays. */
#include "xtensa-xtregs.c"
class xtensa_linux_nat_target final : public linux_nat_target
{
public:
/* Add our register access methods. */
void fetch_registers (struct regcache *, int) override;
void store_registers (struct regcache *, int) override;
};
static xtensa_linux_nat_target the_xtensa_linux_nat_target;
void
fill_gregset (const struct regcache *regcache,
gdb_gregset_t *gregsetp, int regnum)
{
int i;
xtensa_elf_gregset_t *regs = (xtensa_elf_gregset_t *) gregsetp;
struct gdbarch *gdbarch = regcache->arch ();
xtensa_gdbarch_tdep *tdep = gdbarch_tdep<xtensa_gdbarch_tdep> (gdbarch);
if (regnum == gdbarch_pc_regnum (gdbarch) || regnum == -1)
regcache->raw_collect (gdbarch_pc_regnum (gdbarch), &regs->pc);
if (regnum == gdbarch_ps_regnum (gdbarch) || regnum == -1)
regcache->raw_collect (gdbarch_ps_regnum (gdbarch), &regs->ps);
if (regnum == tdep->wb_regnum || regnum == -1)
regcache->raw_collect (tdep->wb_regnum,
&regs->windowbase);
if (regnum == tdep->ws_regnum || regnum == -1)
regcache->raw_collect (tdep->ws_regnum,
&regs->windowstart);
if (regnum == tdep->lbeg_regnum || regnum == -1)
regcache->raw_collect (tdep->lbeg_regnum,
&regs->lbeg);
if (regnum == tdep->lend_regnum || regnum == -1)
regcache->raw_collect (tdep->lend_regnum,
&regs->lend);
if (regnum == tdep->lcount_regnum || regnum == -1)
regcache->raw_collect (tdep->lcount_regnum,
&regs->lcount);
if (regnum == tdep->sar_regnum || regnum == -1)
regcache->raw_collect (tdep->sar_regnum,
&regs->sar);
if (regnum == tdep->threadptr_regnum || regnum == -1)
regcache->raw_collect (tdep->threadptr_regnum,
&regs->threadptr);
if (regnum >=tdep->ar_base
&& regnum < tdep->ar_base
+ tdep->num_aregs)
regcache->raw_collect (regnum,
&regs->ar[regnum - tdep->ar_base]);
else if (regnum == -1)
{
for (i = 0; i < tdep->num_aregs; ++i)
regcache->raw_collect (tdep->ar_base + i,
&regs->ar[i]);
}
if (regnum >= tdep->a0_base
&& regnum < tdep->a0_base + C0_NREGS)
regcache->raw_collect (regnum,
&regs->ar[(4 * regs->windowbase + regnum
- tdep->a0_base)
% tdep->num_aregs]);
else if (regnum == -1)
{
for (i = 0; i < C0_NREGS; ++i)
regcache->raw_collect (tdep->a0_base + i,
(&regs->ar[(4 * regs->windowbase + i)
% tdep->num_aregs]));
}
}
static void
supply_gregset_reg (struct regcache *regcache,
const gdb_gregset_t *gregsetp, int regnum)
{
int i;
xtensa_elf_gregset_t *regs = (xtensa_elf_gregset_t *) gregsetp;
struct gdbarch *gdbarch = regcache->arch ();
xtensa_gdbarch_tdep *tdep = gdbarch_tdep<xtensa_gdbarch_tdep> (gdbarch);
if (regnum == gdbarch_pc_regnum (gdbarch) || regnum == -1)
regcache->raw_supply (gdbarch_pc_regnum (gdbarch), &regs->pc);
if (regnum == gdbarch_ps_regnum (gdbarch) || regnum == -1)
regcache->raw_supply (gdbarch_ps_regnum (gdbarch), &regs->ps);
if (regnum == tdep->wb_regnum || regnum == -1)
regcache->raw_supply (tdep->wb_regnum,
&regs->windowbase);
if (regnum == tdep->ws_regnum || regnum == -1)
regcache->raw_supply (tdep->ws_regnum,
&regs->windowstart);
if (regnum == tdep->lbeg_regnum || regnum == -1)
regcache->raw_supply (tdep->lbeg_regnum,
&regs->lbeg);
if (regnum == tdep->lend_regnum || regnum == -1)
regcache->raw_supply (tdep->lend_regnum,
&regs->lend);
if (regnum == tdep->lcount_regnum || regnum == -1)
regcache->raw_supply (tdep->lcount_regnum,
&regs->lcount);
if (regnum == tdep->sar_regnum || regnum == -1)
regcache->raw_supply (tdep->sar_regnum,
&regs->sar);
if (regnum == tdep->threadptr_regnum || regnum == -1)
regcache->raw_supply (tdep->threadptr_regnum,
&regs->threadptr);
if (regnum >=tdep->ar_base
&& regnum < tdep->ar_base
+ tdep->num_aregs)
regcache->raw_supply (regnum,
&regs->ar[regnum - tdep->ar_base]);
else if (regnum == -1)
{
for (i = 0; i < tdep->num_aregs; ++i)
regcache->raw_supply (tdep->ar_base + i,
&regs->ar[i]);
}
if (regnum >= tdep->a0_base
&& regnum < tdep->a0_base + C0_NREGS)
regcache->raw_supply (regnum,
&regs->ar[(4 * regs->windowbase + regnum
- tdep->a0_base)
% tdep->num_aregs]);
else if (regnum == -1)
{
for (i = 0; i < C0_NREGS; ++i)
regcache->raw_supply (tdep->a0_base + i,
&regs->ar[(4 * regs->windowbase + i)
% tdep->num_aregs]);
}
}
void
supply_gregset (struct regcache *regcache, const gdb_gregset_t *gregsetp)
{
supply_gregset_reg (regcache, gregsetp, -1);
}
void
fill_fpregset (const struct regcache *regcache,
gdb_fpregset_t *fpregsetp, int regnum)
{
return;
}
void
supply_fpregset (struct regcache *regcache,
const gdb_fpregset_t *fpregsetp)
{
return;
}
/* Fetch greg-register(s) from process/thread TID
and store value(s) in GDB's register array. */
static void
fetch_gregs (struct regcache *regcache, int regnum)
{
int tid = regcache->ptid ().lwp ();
gdb_gregset_t regs;
if (ptrace (PTRACE_GETREGS, tid, 0, (long) &regs) < 0)
{
perror_with_name (_("Couldn't get registers"));
return;
}
supply_gregset_reg (regcache, &regs, regnum);
}
/* Store greg-register(s) in GDB's register
array into the process/thread specified by TID. */
static void
store_gregs (struct regcache *regcache, int regnum)
{
int tid = regcache->ptid ().lwp ();
gdb_gregset_t regs;
if (ptrace (PTRACE_GETREGS, tid, 0, (long) &regs) < 0)
{
perror_with_name (_("Couldn't get registers"));
return;
}
fill_gregset (regcache, &regs, regnum);
if (ptrace (PTRACE_SETREGS, tid, 0, (long) &regs) < 0)
{
perror_with_name (_("Couldn't write registers"));
return;
}
}
static int xtreg_lo;
static int xtreg_high;
/* Fetch/Store Xtensa TIE registers. Xtensa GNU/Linux PTRACE
interface provides special requests for this. */
static void
fetch_xtregs (struct regcache *regcache, int regnum)
{
int tid = regcache->ptid ().lwp ();
const xtensa_regtable_t *ptr;
char xtregs [XTENSA_ELF_XTREG_SIZE];
if (ptrace (PTRACE_GETXTREGS, tid, 0, (long)&xtregs) < 0)
perror_with_name (_("Couldn't get extended registers"));
for (ptr = xtensa_regmap_table; ptr->name; ptr++)
if (regnum == ptr->gdb_regnum || regnum == -1)
regcache->raw_supply (ptr->gdb_regnum, xtregs + ptr->ptrace_offset);
}
static void
store_xtregs (struct regcache *regcache, int regnum)
{
int tid = regcache->ptid ().lwp ();
const xtensa_regtable_t *ptr;
char xtregs [XTENSA_ELF_XTREG_SIZE];
if (ptrace (PTRACE_GETXTREGS, tid, 0, (long)&xtregs) < 0)
perror_with_name (_("Couldn't get extended registers"));
for (ptr = xtensa_regmap_table; ptr->name; ptr++)
if (regnum == ptr->gdb_regnum || regnum == -1)
regcache->raw_collect (ptr->gdb_regnum, xtregs + ptr->ptrace_offset);
if (ptrace (PTRACE_SETXTREGS, tid, 0, (long)&xtregs) < 0)
perror_with_name (_("Couldn't write extended registers"));
}
void
xtensa_linux_nat_target::fetch_registers (struct regcache *regcache,
int regnum)
{
if (regnum == -1)
{
fetch_gregs (regcache, regnum);
fetch_xtregs (regcache, regnum);
}
else if ((regnum < xtreg_lo) || (regnum > xtreg_high))
fetch_gregs (regcache, regnum);
else
fetch_xtregs (regcache, regnum);
}
void
xtensa_linux_nat_target::store_registers (struct regcache *regcache,
int regnum)
{
if (regnum == -1)
{
store_gregs (regcache, regnum);
store_xtregs (regcache, regnum);
}
else if ((regnum < xtreg_lo) || (regnum > xtreg_high))
store_gregs (regcache, regnum);
else
store_xtregs (regcache, regnum);
}
/* Called by libthread_db. */
ps_err_e
ps_get_thread_area (struct ps_prochandle *ph,
lwpid_t lwpid, int idx, void **base)
{
xtensa_elf_gregset_t regs;
if (ptrace (PTRACE_GETREGS, lwpid, NULL, &regs) != 0)
return PS_ERR;
/* IDX is the bias from the thread pointer to the beginning of the
thread descriptor. It has to be subtracted due to implementation
quirks in libthread_db. */
*base = (void *) ((char *) regs.threadptr - idx);
return PS_OK;
}
void _initialize_xtensa_linux_nat ();
void
_initialize_xtensa_linux_nat ()
{
const xtensa_regtable_t *ptr;
/* Calculate the number range for extended registers. */
xtreg_lo = 1000000000;
xtreg_high = -1;
for (ptr = xtensa_regmap_table; ptr->name; ptr++)
{
if (ptr->gdb_regnum < xtreg_lo)
xtreg_lo = ptr->gdb_regnum;
if (ptr->gdb_regnum > xtreg_high)
xtreg_high = ptr->gdb_regnum;
}
linux_target = &the_xtensa_linux_nat_target;
add_inf_child_target (&the_xtensa_linux_nat_target);
}