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