gdb/config/pa/tm-hppa.h

   1 /* Parameters for execution on any Hewlett-Packard PA-RISC machine.
   2
   3    Copyright 1986, 1987, 1989, 1990, 1991, 1992, 1993, 1994, 1995,
   4    1996, 1998, 1999, 2000, 2001, 2002, 2003, 2004 Free Software
   5    Foundation, Inc.
   6
   7    Contributed by the Center for Software Science at the
   8    University of Utah (pa-gdb-bugs@cs.utah.edu).
   9
  10    This file is part of GDB.
  11
  12    This program is free software; you can redistribute it and/or modify
  13    it under the terms of the GNU General Public License as published by
  14    the Free Software Foundation; either version 2 of the License, or
  15    (at your option) any later version.
  16
  17    This program is distributed in the hope that it will be useful,
  18    but WITHOUT ANY WARRANTY; without even the implied warranty of
  19    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20    GNU General Public License for more details.
  21
  22    You should have received a copy of the GNU General Public License
  23    along with this program; if not, write to the Free Software
  24    Foundation, Inc., 59 Temple Place - Suite 330,
  25    Boston, MA 02111-1307, USA.  */
  26
  27 #include "regcache.h"
  28
  29 /* Wonder if this is correct?  Should be using push_dummy_call().  */
  30 #define DEPRECATED_DUMMY_WRITE_SP(SP) deprecated_write_sp (SP)
  31
  32 #define GDB_MULTI_ARCH 1
  33
  34 /* NOTE: cagney/2002-11-24: This is a guess.  */
  35 #define DEPRECATED_USE_GENERIC_DUMMY_FRAMES 0
  36 #define CALL_DUMMY_LOCATION ON_STACK
  37 #define DEPRECATED_PC_IN_CALL_DUMMY(pc, sp, frame_address) deprecated_pc_in_call_dummy_on_stack (pc, sp, frame_address)
  38 /* Hack, get around problem with including "arch-utils.h".  */
  39 struct frame_info;
  40
  41 /* Forward declarations of some types we use in prototypes */
  42
  43 struct frame_info;
  44 struct frame_saved_regs;
  45 struct value;
  46 struct type;
  47 struct inferior_status;
  48
  49 /* Sequence of bytes for breakpoint instruction.  */
  50
  51 const unsigned char *hppa_breakpoint_from_pc (CORE_ADDR *pcptr, int *lenptr);
  52 #define BREAKPOINT_FROM_PC(PCPTR,LENPTR) hppa_breakpoint_from_pc ((PCPTR), (LENPTR))
  53 #define BREAKPOINT32 0x10004
  54
  55 extern int hppa_pc_requires_run_before_use (CORE_ADDR pc);
  56 #define PC_REQUIRES_RUN_BEFORE_USE(pc) hppa_pc_requires_run_before_use (pc)
  57
  58 /* Register numbers of various important registers.
  59    Note that some of these values are "real" register numbers,
  60    and correspond to the general registers of the machine,
  61    and some are "phony" register numbers which are too large
  62    to be actual register numbers as far as the user is concerned
  63    but do serve to get the desired values when passed to read_register.  */
  64
  65 #define R0_REGNUM 0             /* Doesn't actually exist, used as base for
  66                                    other r registers.  */
  67 #define FLAGS_REGNUM 0          /* Various status flags */
  68 #define RP_REGNUM 2             /* return pointer */
  69 #define SAR_REGNUM 32           /* Shift Amount Register */
  70 #define IPSW_REGNUM 41          /* Interrupt Processor Status Word */
  71 #define PCOQ_HEAD_REGNUM 33     /* instruction offset queue head */
  72 #define PCSQ_HEAD_REGNUM 34     /* instruction space queue head */
  73 #define PCOQ_TAIL_REGNUM 35     /* instruction offset queue tail */
  74 #define PCSQ_TAIL_REGNUM 36     /* instruction space queue tail */
  75 #define EIEM_REGNUM 37          /* External Interrupt Enable Mask */
  76 #define IIR_REGNUM 38           /* Interrupt Instruction Register */
  77 #define IOR_REGNUM 40           /* Interrupt Offset Register */
  78 #define SR4_REGNUM 43           /* space register 4 */
  79 #define RCR_REGNUM 51           /* Recover Counter (also known as cr0) */
  80 #define CCR_REGNUM 54           /* Coprocessor Configuration Register */
  81 #define TR0_REGNUM 57           /* Temporary Registers (cr24 -> cr31) */
  82 #define CR27_REGNUM 60          /* Base register for thread-local storage, cr27 */
  83 #define FP4_REGNUM 72
  84
  85 #define ARG0_REGNUM 26          /* The first argument of a callee. */
  86 #define ARG1_REGNUM 25          /* The second argument of a callee. */
  87 #define ARG2_REGNUM 24          /* The third argument of a callee. */
  88 #define ARG3_REGNUM 23          /* The fourth argument of a callee. */
  89
  90 /* When fetching register values from an inferior or a core file,
  91    clean them up using this macro.  BUF is a char pointer to
  92    the raw value of the register in the registers[] array.  */
  93
  94 #define DEPRECATED_CLEAN_UP_REGISTER_VALUE(regno, buf) \
  95   do {  \
  96     if ((regno) == PCOQ_HEAD_REGNUM || (regno) == PCOQ_TAIL_REGNUM) \
  97       (buf)[sizeof(CORE_ADDR) -1] &= ~0x3; \
  98   } while (0)
  99
 100 /* Define DEPRECATED_DO_REGISTERS_INFO() to do machine-specific
 101    formatting of register dumps. */
 102
 103 #define DEPRECATED_DO_REGISTERS_INFO(_regnum, fp) pa_do_registers_info (_regnum, fp)
 104 extern void pa_do_registers_info (int, int);
 105
 106 /* PA specific macro to see if the current instruction is nullified. */
 107 #ifndef INSTRUCTION_NULLIFIED
 108 extern int hppa_instruction_nullified (void);
 109 #define INSTRUCTION_NULLIFIED hppa_instruction_nullified ()
 110 #endif
 111
 112 #define INSTRUCTION_SIZE 4
 113
 114 /* This sequence of words is the instructions
 115
 116    ; Call stack frame has already been built by gdb. Since we could be calling
 117    ; a varargs function, and we do not have the benefit of a stub to put things in
 118    ; the right place, we load the first 4 word of arguments into both the general
 119    ; and fp registers.
 120    call_dummy
 121    ldw -36(sp), arg0
 122    ldw -40(sp), arg1
 123    ldw -44(sp), arg2
 124    ldw -48(sp), arg3
 125    ldo -36(sp), r1
 126    fldws 0(0, r1), fr4
 127    fldds -4(0, r1), fr5
 128    fldws -8(0, r1), fr6
 129    fldds -12(0, r1), fr7
 130    ldil 0, r22                  ; FUNC_LDIL_OFFSET must point here
 131    ldo 0(r22), r22                      ; FUNC_LDO_OFFSET must point here
 132    ldsid (0,r22), r4
 133    ldil 0, r1                   ; SR4EXPORT_LDIL_OFFSET must point here
 134    ldo 0(r1), r1                        ; SR4EXPORT_LDO_OFFSET must point here
 135    ldsid (0,r1), r20
 136    combt,=,n r4, r20, text_space        ; If target is in data space, do a
 137    ble 0(sr5, r22)                      ; "normal" procedure call
 138    copy r31, r2
 139    break 4, 8
 140    mtsp r21, sr0
 141    ble,n 0(sr0, r22)
 142    text_space                           ; Otherwise, go through _sr4export,
 143    ble (sr4, r1)                        ; which will return back here.
 144    stw r31,-24(r30)
 145    break 4, 8
 146    mtsp r21, sr0
 147    ble,n 0(sr0, r22)
 148    nop                          ; To avoid kernel bugs
 149    nop                          ; and keep the dummy 8 byte aligned
 150
 151    The dummy decides if the target is in text space or data space. If
 152    it's in data space, there's no problem because the target can
 153    return back to the dummy. However, if the target is in text space,
 154    the dummy calls the secret, undocumented routine _sr4export, which
 155    calls a function in text space and can return to any space. Instead
 156    of including fake instructions to represent saved registers, we
 157    know that the frame is associated with the call dummy and treat it
 158    specially.
 159
 160    The trailing NOPs are needed to avoid a bug in HPUX, BSD and OSF1
 161    kernels.   If the memory at the location pointed to by the PC is
 162    0xffffffff then a ptrace step call will fail (even if the instruction
 163    is nullified).
 164
 165    The code to pop a dummy frame single steps three instructions
 166    starting with the last mtsp.  This includes the nullified "instruction"
 167    following the ble (which is uninitialized junk).  If the
 168    "instruction" following the last BLE is 0xffffffff, then the ptrace
 169    will fail and the dummy frame is not correctly popped.
 170
 171    By placing a NOP in the delay slot of the BLE instruction we can be
 172    sure that we never try to execute a 0xffffffff instruction and
 173    avoid the kernel bug.  The second NOP is needed to keep the call
 174    dummy 8 byte aligned.  */
 175
 176 #define CALL_DUMMY {0x4BDA3FB9, 0x4BD93FB1, 0x4BD83FA9, 0x4BD73FA1,\
 177                     0x37C13FB9, 0x24201004, 0x2C391005, 0x24311006,\
 178                     0x2C291007, 0x22C00000, 0x36D60000, 0x02C010A4,\
 179                     0x20200000, 0x34210000, 0x002010b4, 0x82842022,\
 180                     0xe6c06000, 0x081f0242, 0x00010004, 0x00151820,\
 181                     0xe6c00002, 0xe4202000, 0x6bdf3fd1, 0x00010004,\
 182                     0x00151820, 0xe6c00002, 0x08000240, 0x08000240}
 183
 184 #define REG_PARM_STACK_SPACE 16
 185
 186 /* If we've reached a trap instruction within the call dummy, then
 187    we'll consider that to mean that we've reached the call dummy's
 188    end after its successful completion. */
 189 #define DEPRECATED_CALL_DUMMY_HAS_COMPLETED(pc, sp, frame_address) \
 190   (DEPRECATED_PC_IN_CALL_DUMMY((pc), (sp), (frame_address)) && \
 191    (read_memory_integer((pc), 4) == BREAKPOINT32))
 192
 193 /* Insert the specified number of args and function address into a
 194    call sequence of the above form stored at DUMMYNAME.
 195
 196    On the hppa we need to call the stack dummy through $$dyncall.
 197    Therefore our version of DEPRECATED_FIX_CALL_DUMMY takes an extra
 198    argument, real_pc, which is the location where gdb should start up
 199    the inferior to do the function call.  */
 200
 201 /* FIXME: brobecker 2002-12-26.  This macro is going to cause us some
 202    problems before we can go to multiarch partial as it has been
 203    diverted on HPUX to return the value of the PC!  */
 204 /* NOTE: cagney/2003-05-03: This has been replaced by push_dummy_code.
 205    Hopefully that has all the parameters HP/UX needs.  */
 206 #define DEPRECATED_FIX_CALL_DUMMY hppa_fix_call_dummy
 207 extern CORE_ADDR hppa_fix_call_dummy (char *, CORE_ADDR, CORE_ADDR, int,
 208                                       struct value **, struct type *, int);
 209
 210 #define GDB_TARGET_IS_HPPA
 211
 212 /*
 213  * Unwind table and descriptor.
 214  */
 215
 216 struct unwind_table_entry
 217   {
 218     CORE_ADDR region_start;
 219     CORE_ADDR region_end;
 220
 221     unsigned int Cannot_unwind:1;       /* 0 */
 222     unsigned int Millicode:1;   /* 1 */
 223     unsigned int Millicode_save_sr0:1;  /* 2 */
 224     unsigned int Region_description:2;  /* 3..4 */
 225     unsigned int reserved1:1;   /* 5 */
 226     unsigned int Entry_SR:1;    /* 6 */
 227     unsigned int Entry_FR:4;    /* number saved *//* 7..10 */
 228     unsigned int Entry_GR:5;    /* number saved *//* 11..15 */
 229     unsigned int Args_stored:1; /* 16 */
 230     unsigned int Variable_Frame:1;      /* 17 */
 231     unsigned int Separate_Package_Body:1;       /* 18 */
 232     unsigned int Frame_Extension_Millicode:1;   /* 19 */
 233     unsigned int Stack_Overflow_Check:1;        /* 20 */
 234     unsigned int Two_Instruction_SP_Increment:1;        /* 21 */
 235     unsigned int Ada_Region:1;  /* 22 */
 236     unsigned int cxx_info:1;    /* 23 */
 237     unsigned int cxx_try_catch:1;       /* 24 */
 238     unsigned int sched_entry_seq:1;     /* 25 */
 239     unsigned int reserved2:1;   /* 26 */
 240     unsigned int Save_SP:1;     /* 27 */
 241     unsigned int Save_RP:1;     /* 28 */
 242     unsigned int Save_MRP_in_frame:1;   /* 29 */
 243     unsigned int extn_ptr_defined:1;    /* 30 */
 244     unsigned int Cleanup_defined:1;     /* 31 */
 245
 246     unsigned int MPE_XL_interrupt_marker:1;     /* 0 */
 247     unsigned int HP_UX_interrupt_marker:1;      /* 1 */
 248     unsigned int Large_frame:1; /* 2 */
 249     unsigned int Pseudo_SP_Set:1;       /* 3 */
 250     unsigned int reserved4:1;   /* 4 */
 251     unsigned int Total_frame_size:27;   /* 5..31 */
 252
 253     /* This is *NOT* part of an actual unwind_descriptor in an object
 254        file.  It is *ONLY* part of the "internalized" descriptors that
 255        we create from those in a file.
 256      */
 257     struct
 258       {
 259         unsigned int stub_type:4;       /* 0..3 */
 260         unsigned int padding:28;        /* 4..31 */
 261       }
 262     stub_unwind;
 263   };
 264
 265 /* HP linkers also generate unwinds for various linker-generated stubs.
 266    GDB reads in the stubs from the $UNWIND_END$ subspace, then
 267    "converts" them into normal unwind entries using some of the reserved
 268    fields to store the stub type.  */
 269
 270 /* The gaps represent linker stubs used in MPE and space for future
 271    expansion.  */
 272 enum unwind_stub_types
 273   {
 274     LONG_BRANCH = 1,
 275     PARAMETER_RELOCATION = 2,
 276     EXPORT = 10,
 277     IMPORT = 11,
 278     IMPORT_SHLIB = 12,
 279   };
 280
 281 /* We use the objfile->obj_private pointer for two things:
 282
 283  * 1.  An unwind table;
 284  *
 285  * 2.  A pointer to any associated shared library object.
 286  *
 287  * #defines are used to help refer to these objects.
 288  */
 289
 290 /* Info about the unwind table associated with an object file.
 291
 292  * This is hung off of the "objfile->obj_private" pointer, and
 293  * is allocated in the objfile's psymbol obstack.  This allows
 294  * us to have unique unwind info for each executable and shared
 295  * library that we are debugging.
 296  */
 297 struct obj_unwind_info
 298   {
 299     struct unwind_table_entry *table;   /* Pointer to unwind info */
 300     struct unwind_table_entry *cache;   /* Pointer to last entry we found */
 301     int last;                   /* Index of last entry */
 302   };
 303
 304 typedef struct obj_private_struct
 305   {
 306     struct obj_unwind_info *unwind_info;        /* a pointer */
 307     struct so_list *so_info;    /* a pointer  */
 308     CORE_ADDR dp;
 309   }
 310 obj_private_data_t;
 311
 312 /* For a number of horrible reasons we may have to adjust the location
 313    of variables on the stack.  Ugh.  */
 314 #define HPREAD_ADJUST_STACK_ADDRESS(ADDR) hpread_adjust_stack_address(ADDR)
 315 extern int hpread_adjust_stack_address (CORE_ADDR);
 316
 317 /* Here's how to step off a permanent breakpoint.  */
 318 #define SKIP_PERMANENT_BREAKPOINT (hppa_skip_permanent_breakpoint)
 319 extern void hppa_skip_permanent_breakpoint (void);
 320
 321 /* On HP-UX, certain system routines (millicode) have names beginning
 322    with $ or $$, e.g. $$dyncall, which handles inter-space procedure
 323    calls on PA-RISC.  Tell the expression parser to check for those
 324    when parsing tokens that begin with "$".  */
 325 #define SYMBOLS_CAN_START_WITH_DOLLAR (1)