binutils-gdb/gdb/arm-none-tdep.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

214 lines
6.4 KiB
C

/* none on ARM target support.
Copyright (C) 2020-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 "arm-tdep.h"
#include "arch-utils.h"
#include "regcache.h"
#include "elf-bfd.h"
#include "regset.h"
#include "user-regs.h"
#ifdef HAVE_ELF
#include "elf-none-tdep.h"
#endif
/* Core file and register set support. */
#define ARM_NONE_SIZEOF_GREGSET (18 * ARM_INT_REGISTER_SIZE)
/* Support VFP register format. */
#define ARM_NONE_SIZEOF_VFP (32 * 8 + 4)
/* The index to access CPSR in user_regs as defined in GLIBC. */
#define ARM_NONE_CPSR_GREGNUM 16
/* Supply register REGNUM from buffer GREGS_BUF (length LEN bytes) into
REGCACHE. If REGNUM is -1 then supply all registers. The set of
registers that this function will supply is limited to the general
purpose registers.
The layout of the registers here is based on the ARM GNU/Linux
layout. */
static void
arm_none_supply_gregset (const struct regset *regset,
struct regcache *regcache,
int regnum, const void *gregs_buf, size_t len)
{
struct gdbarch *gdbarch = regcache->arch ();
enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
const gdb_byte *gregs = (const gdb_byte *) gregs_buf;
for (int regno = ARM_A1_REGNUM; regno < ARM_PC_REGNUM; regno++)
if (regnum == -1 || regnum == regno)
regcache->raw_supply (regno, gregs + ARM_INT_REGISTER_SIZE * regno);
if (regnum == ARM_PS_REGNUM || regnum == -1)
{
if (arm_apcs_32)
regcache->raw_supply (ARM_PS_REGNUM,
gregs + ARM_INT_REGISTER_SIZE
* ARM_NONE_CPSR_GREGNUM);
else
regcache->raw_supply (ARM_PS_REGNUM,
gregs + ARM_INT_REGISTER_SIZE * ARM_PC_REGNUM);
}
if (regnum == ARM_PC_REGNUM || regnum == -1)
{
gdb_byte pc_buf[ARM_INT_REGISTER_SIZE];
CORE_ADDR reg_pc
= extract_unsigned_integer (gregs + ARM_INT_REGISTER_SIZE
* ARM_PC_REGNUM,
ARM_INT_REGISTER_SIZE, byte_order);
reg_pc = gdbarch_addr_bits_remove (gdbarch, reg_pc);
store_unsigned_integer (pc_buf, ARM_INT_REGISTER_SIZE, byte_order,
reg_pc);
regcache->raw_supply (ARM_PC_REGNUM, pc_buf);
}
}
/* Collect register REGNUM from REGCACHE and place it into buffer GREGS_BUF
(length LEN bytes). If REGNUM is -1 then collect all registers. The
set of registers that this function will collect is limited to the
general purpose registers.
The layout of the registers here is based on the ARM GNU/Linux
layout. */
static void
arm_none_collect_gregset (const struct regset *regset,
const struct regcache *regcache,
int regnum, void *gregs_buf, size_t len)
{
gdb_byte *gregs = (gdb_byte *) gregs_buf;
for (int regno = ARM_A1_REGNUM; regno < ARM_PC_REGNUM; regno++)
if (regnum == -1 || regnum == regno)
regcache->raw_collect (regno,
gregs + ARM_INT_REGISTER_SIZE * regno);
if (regnum == ARM_PS_REGNUM || regnum == -1)
{
if (arm_apcs_32)
regcache->raw_collect (ARM_PS_REGNUM,
gregs + ARM_INT_REGISTER_SIZE
* ARM_NONE_CPSR_GREGNUM);
else
regcache->raw_collect (ARM_PS_REGNUM,
gregs + ARM_INT_REGISTER_SIZE * ARM_PC_REGNUM);
}
if (regnum == ARM_PC_REGNUM || regnum == -1)
regcache->raw_collect (ARM_PC_REGNUM,
gregs + ARM_INT_REGISTER_SIZE * ARM_PC_REGNUM);
}
/* Supply VFP registers from REGS_BUF into REGCACHE. */
static void
arm_none_supply_vfp (const struct regset *regset,
struct regcache *regcache,
int regnum, const void *regs_buf, size_t len)
{
const gdb_byte *regs = (const gdb_byte *) regs_buf;
if (regnum == ARM_FPSCR_REGNUM || regnum == -1)
regcache->raw_supply (ARM_FPSCR_REGNUM, regs + 32 * 8);
for (int regno = ARM_D0_REGNUM; regno <= ARM_D31_REGNUM; regno++)
if (regnum == -1 || regnum == regno)
regcache->raw_supply (regno, regs + (regno - ARM_D0_REGNUM) * 8);
}
/* Collect VFP registers from REGCACHE into REGS_BUF. */
static void
arm_none_collect_vfp (const struct regset *regset,
const struct regcache *regcache,
int regnum, void *regs_buf, size_t len)
{
gdb_byte *regs = (gdb_byte *) regs_buf;
if (regnum == ARM_FPSCR_REGNUM || regnum == -1)
regcache->raw_collect (ARM_FPSCR_REGNUM, regs + 32 * 8);
for (int regno = ARM_D0_REGNUM; regno <= ARM_D31_REGNUM; regno++)
if (regnum == -1 || regnum == regno)
regcache->raw_collect (regno, regs + (regno - ARM_D0_REGNUM) * 8);
}
/* The general purpose register set. */
static const struct regset arm_none_gregset =
{
nullptr, arm_none_supply_gregset, arm_none_collect_gregset
};
/* The VFP register set. */
static const struct regset arm_none_vfpregset =
{
nullptr, arm_none_supply_vfp, arm_none_collect_vfp
};
/* Iterate over core file register note sections. */
static void
arm_none_iterate_over_regset_sections (struct gdbarch *gdbarch,
iterate_over_regset_sections_cb *cb,
void *cb_data,
const struct regcache *regcache)
{
arm_gdbarch_tdep *tdep = gdbarch_tdep<arm_gdbarch_tdep> (gdbarch);
cb (".reg", ARM_NONE_SIZEOF_GREGSET, ARM_NONE_SIZEOF_GREGSET,
&arm_none_gregset, nullptr, cb_data);
if (tdep->vfp_register_count > 0)
cb (".reg-arm-vfp", ARM_NONE_SIZEOF_VFP, ARM_NONE_SIZEOF_VFP,
&arm_none_vfpregset, "VFP floating-point", cb_data);
}
/* Initialize ARM bare-metal ABI info. */
static void
arm_none_init_abi (struct gdbarch_info info, struct gdbarch *gdbarch)
{
#ifdef HAVE_ELF
elf_none_init_abi (gdbarch);
#endif
/* Iterate over registers for reading and writing bare metal ARM core
files. */
set_gdbarch_iterate_over_regset_sections
(gdbarch, arm_none_iterate_over_regset_sections);
}
/* Initialize ARM bare-metal target support. */
void _initialize_arm_none_tdep ();
void
_initialize_arm_none_tdep ()
{
gdbarch_register_osabi (bfd_arch_arm, 0, GDB_OSABI_NONE,
arm_none_init_abi);
}