gdb/config/pa/tm-hppa.h

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