gdb/arc-tdep.h

   1 /* Target dependent code for ARC architecture, for GDB.
   2
   3    Copyright 2005-2020 Free Software Foundation, Inc.
   4    Contributed by Synopsys Inc.
   5
   6    This file is part of GDB.
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  20
  21 #ifndef ARC_TDEP_H
  22 #define ARC_TDEP_H
  23
  24 /* Need disassemble_info.  */
  25 #include "dis-asm.h"
  26 #include "gdbarch.h"
  27 #include "arch/arc.h"
  28
  29 /* To simplify GDB code this enum assumes that internal regnums should be same
  30    as architectural register numbers, i.e. PCL regnum is 63.  This allows to
  31    use internal GDB regnums as architectural numbers when dealing with
  32    instruction encodings, for example when analyzing what are the registers
  33    saved in function prologue.  */
  34
  35 enum arc_regnum
  36   {
  37     /* Core registers.  */
  38     ARC_R0_REGNUM = 0,
  39     ARC_R1_REGNUM = 1,
  40     ARC_R4_REGNUM = 4,
  41     ARC_R7_REGNUM = 7,
  42     ARC_R9_REGNUM = 9,
  43     ARC_R13_REGNUM = 13,
  44     ARC_R16_REGNUM = 16,
  45     ARC_R25_REGNUM = 25,
  46     /* Global data pointer.  */
  47     ARC_GP_REGNUM,
  48     /* Frame pointer.  */
  49     ARC_FP_REGNUM,
  50     /* Stack pointer.  */
  51     ARC_SP_REGNUM,
  52     /* Return address from interrupt.  */
  53     ARC_ILINK_REGNUM,
  54     ARC_R30_REGNUM,
  55     /* Return address from function.  */
  56     ARC_BLINK_REGNUM,
  57     /* Accumulator registers.  */
  58     ARC_R58_REGNUM = 58,
  59     ARC_R59_REGNUM,
  60     /* Zero-delay loop counter.  */
  61     ARC_LP_COUNT_REGNUM = 60,
  62     /* Reserved register number.  There should never be a register with such
  63        number, this name is needed only for a sanity check in
  64       arc_cannot_(fetch|store)_register.  */
  65     ARC_RESERVED_REGNUM,
  66     /* Long-immediate value.  This is not a physical register - if instruction
  67        has register 62 as an operand, then this operand is a literal value
  68        stored in the instruction memory right after the instruction itself.
  69        This value is required in this enumeration as an architectural number
  70        for instruction analysis.  */
  71     ARC_LIMM_REGNUM,
  72     /* Program counter, aligned to 4-bytes, read-only.  */
  73     ARC_PCL_REGNUM,
  74     ARC_LAST_CORE_REGNUM = ARC_PCL_REGNUM,
  75
  76     /* AUX registers.  */
  77     /* Actual program counter.  */
  78     ARC_PC_REGNUM,
  79     ARC_FIRST_AUX_REGNUM = ARC_PC_REGNUM,
  80     /* Status register.  */
  81     ARC_STATUS32_REGNUM,
  82     /* Zero-delay loop start instruction.  */
  83     ARC_LP_START_REGNUM,
  84     /* Zero-delay loop next-after-last instruction.  */
  85     ARC_LP_END_REGNUM,
  86     /* Branch target address.  */
  87     ARC_BTA_REGNUM,
  88     /* Exception return address.  */
  89     ARC_ERET_REGNUM,
  90     ARC_LAST_AUX_REGNUM = ARC_ERET_REGNUM,
  91     ARC_LAST_REGNUM = ARC_LAST_AUX_REGNUM,
  92
  93     /* Additional ABI constants.  */
  94     ARC_FIRST_ARG_REGNUM = ARC_R0_REGNUM,
  95     ARC_LAST_ARG_REGNUM = ARC_R7_REGNUM,
  96     ARC_FIRST_CALLEE_SAVED_REGNUM = ARC_R13_REGNUM,
  97     ARC_LAST_CALLEE_SAVED_REGNUM = ARC_R25_REGNUM,
  98   };
  99
 100 /* Number of bytes in ARC register.  All ARC registers are considered 32-bit.
 101    Those registers, which are actually shorter has zero-on-read for extra bits.
 102    Longer registers are represented as pairs of 32-bit registers.  */
 103 #define ARC_REGISTER_SIZE  4
 104
 105 /* STATUS32 register: hardware loops disabled bit.  */
 106 #define ARC_STATUS32_L_MASK (1 << 12)
 107 /* STATUS32 register: current instruction is a delay slot.  */
 108 #define ARC_STATUS32_DE_MASK (1 << 6)
 109
 110 /* Special value for register offset arrays.  */
 111 #define ARC_OFFSET_NO_REGISTER (-1)
 112
 113 #define arc_print(fmt, args...) fprintf_unfiltered (gdb_stdlog, fmt, ##args)
 114
 115 extern int arc_debug;
 116
 117 /* Target-dependent information.  */
 118
 119 struct gdbarch_tdep
 120 {
 121   /* Offset to PC value in jump buffer.  If this is negative, longjmp
 122      support will be disabled.  */
 123   int jb_pc;
 124
 125   /* Whether target has hardware (aka zero-delay) loops.  */
 126   bool has_hw_loops;
 127 };
 128
 129 /* Utility functions used by other ARC-specific modules.  */
 130
 131 static inline int
 132 arc_mach_is_arc600 (struct gdbarch *gdbarch)
 133 {
 134   return (gdbarch_bfd_arch_info (gdbarch)->mach == bfd_mach_arc_arc600
 135           || gdbarch_bfd_arch_info (gdbarch)->mach == bfd_mach_arc_arc601);
 136 }
 137
 138 static inline int
 139 arc_mach_is_arc700 (struct gdbarch *gdbarch)
 140 {
 141   return gdbarch_bfd_arch_info (gdbarch)->mach == bfd_mach_arc_arc700;
 142 }
 143
 144 static inline int
 145 arc_mach_is_arcv2 (struct gdbarch *gdbarch)
 146 {
 147   return gdbarch_bfd_arch_info (gdbarch)->mach == bfd_mach_arc_arcv2;
 148 }
 149
 150 /* ARC EM and ARC HS are unique BFD arches, however they share the same machine
 151    number as "ARCv2".  */
 152
 153 static inline bool
 154 arc_arch_is_hs (const struct bfd_arch_info* arch)
 155 {
 156   return startswith (arch->printable_name, "HS");
 157 }
 158
 159 static inline bool
 160 arc_arch_is_em (const struct bfd_arch_info* arch)
 161 {
 162   return startswith (arch->printable_name, "EM");
 163 }
 164
 165 /* Function to access ARC disassembler.  Underlying opcodes disassembler will
 166    print an instruction into stream specified in the INFO, so if it is
 167    undesired, then this stream should be set to some invisible stream, but it
 168    can't be set to an actual NULL value - that would cause a crash.  */
 169 int arc_delayed_print_insn (bfd_vma addr, struct disassemble_info *info);
 170
 171 /* Return properly initialized disassemble_info for ARC disassembler - it will
 172    not print disassembled instructions to stderr.  */
 173
 174 struct disassemble_info arc_disassemble_info (struct gdbarch *gdbarch);
 175
 176 /* Get branch/jump target address for the INSN.  Note that this function
 177    returns branch target and doesn't evaluate if this branch is taken or not.
 178    For the indirect jumps value depends in register state, hence can change.
 179    It is an error to call this function for a non-branch instruction.  */
 180
 181 CORE_ADDR arc_insn_get_branch_target (const struct arc_instruction &insn);
 182
 183 /* Get address of next instruction after INSN, assuming linear execution (no
 184    taken branches).  If instruction has a delay slot, then returned value will
 185    point at the instruction in delay slot.  That is - "address of instruction +
 186    instruction length with LIMM".  */
 187
 188 CORE_ADDR arc_insn_get_linear_next_pc (const struct arc_instruction &insn);
 189
 190 /* Create an arc_arch_features instance from the provided data.  */
 191
 192 arc_arch_features arc_arch_features_create (const bfd *abfd,
 193                                             const unsigned long mach);
 194
 195 #endif /* ARC_TDEP_H */