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 #define GDB_MULTI_ARCH 1
  31
  32 /* NOTE: cagney/2002-11-24: This is a guess.  */
  33 #define DEPRECATED_USE_GENERIC_DUMMY_FRAMES 0
  34 #define CALL_DUMMY_LOCATION ON_STACK
  35 #define DEPRECATED_PC_IN_CALL_DUMMY(pc, sp, frame_address) deprecated_pc_in_call_dummy_on_stack (pc, sp, frame_address)
  36 /* Hack, get around problem with including "arch-utils.h".  */
  37 struct frame_info;
  38 extern CORE_ADDR init_frame_pc_default (int fromleaf, struct frame_info *prev);
  39 #define DEPRECATED_INIT_FRAME_PC(l,f) (init_frame_pc_default (l, f))
  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 /* elz: Return a large value, which is stored on the stack at addr.
 113    This is defined only for the hppa, at this moment.  The above macro
 114    DEPRECATED_EXTRACT_STRUCT_VALUE_ADDRESS is not called anymore,
 115    because it assumes that on exit from a called function which
 116    returns a large structure on the stack, the address of the ret
 117    structure is still in register 28. Unfortunately this register is
 118    usually overwritten by the called function itself, on hppa. This is
 119    specified in the calling convention doc. As far as I know, the only
 120    way to get the return value is to have the caller tell us where it
 121    told the callee to put it, rather than have the callee tell us.  */
 122 struct value *hppa_value_returned_from_stack (struct type *valtype,
 123                                               CORE_ADDR addr);
 124 #define VALUE_RETURNED_FROM_STACK(valtype,addr) \
 125   hppa_value_returned_from_stack (valtype, addr)
 126
 127 extern void hppa_frame_init_saved_regs (struct frame_info *);
 128 #define DEPRECATED_FRAME_INIT_SAVED_REGS(FI) \
 129   hppa_frame_init_saved_regs (FI)
 130
 131 #define INSTRUCTION_SIZE 4
 132
 133 /* This sequence of words is the instructions
 134
 135    ; Call stack frame has already been built by gdb. Since we could be calling
 136    ; a varargs function, and we do not have the benefit of a stub to put things in
 137    ; the right place, we load the first 4 word of arguments into both the general
 138    ; and fp registers.
 139    call_dummy
 140    ldw -36(sp), arg0
 141    ldw -40(sp), arg1
 142    ldw -44(sp), arg2
 143    ldw -48(sp), arg3
 144    ldo -36(sp), r1
 145    fldws 0(0, r1), fr4
 146    fldds -4(0, r1), fr5
 147    fldws -8(0, r1), fr6
 148    fldds -12(0, r1), fr7
 149    ldil 0, r22                  ; FUNC_LDIL_OFFSET must point here
 150    ldo 0(r22), r22                      ; FUNC_LDO_OFFSET must point here
 151    ldsid (0,r22), r4
 152    ldil 0, r1                   ; SR4EXPORT_LDIL_OFFSET must point here
 153    ldo 0(r1), r1                        ; SR4EXPORT_LDO_OFFSET must point here
 154    ldsid (0,r1), r20
 155    combt,=,n r4, r20, text_space        ; If target is in data space, do a
 156    ble 0(sr5, r22)                      ; "normal" procedure call
 157    copy r31, r2
 158    break 4, 8
 159    mtsp r21, sr0
 160    ble,n 0(sr0, r22)
 161    text_space                           ; Otherwise, go through _sr4export,
 162    ble (sr4, r1)                        ; which will return back here.
 163    stw r31,-24(r30)
 164    break 4, 8
 165    mtsp r21, sr0
 166    ble,n 0(sr0, r22)
 167    nop                          ; To avoid kernel bugs
 168    nop                          ; and keep the dummy 8 byte aligned
 169
 170    The dummy decides if the target is in text space or data space. If
 171    it's in data space, there's no problem because the target can
 172    return back to the dummy. However, if the target is in text space,
 173    the dummy calls the secret, undocumented routine _sr4export, which
 174    calls a function in text space and can return to any space. Instead
 175    of including fake instructions to represent saved registers, we
 176    know that the frame is associated with the call dummy and treat it
 177    specially.
 178
 179    The trailing NOPs are needed to avoid a bug in HPUX, BSD and OSF1
 180    kernels.   If the memory at the location pointed to by the PC is
 181    0xffffffff then a ptrace step call will fail (even if the instruction
 182    is nullified).
 183
 184    The code to pop a dummy frame single steps three instructions
 185    starting with the last mtsp.  This includes the nullified "instruction"
 186    following the ble (which is uninitialized junk).  If the
 187    "instruction" following the last BLE is 0xffffffff, then the ptrace
 188    will fail and the dummy frame is not correctly popped.
 189
 190    By placing a NOP in the delay slot of the BLE instruction we can be
 191    sure that we never try to execute a 0xffffffff instruction and
 192    avoid the kernel bug.  The second NOP is needed to keep the call
 193    dummy 8 byte aligned.  */
 194
 195 #define CALL_DUMMY {0x4BDA3FB9, 0x4BD93FB1, 0x4BD83FA9, 0x4BD73FA1,\
 196                     0x37C13FB9, 0x24201004, 0x2C391005, 0x24311006,\
 197                     0x2C291007, 0x22C00000, 0x36D60000, 0x02C010A4,\
 198                     0x20200000, 0x34210000, 0x002010b4, 0x82842022,\
 199                     0xe6c06000, 0x081f0242, 0x00010004, 0x00151820,\
 200                     0xe6c00002, 0xe4202000, 0x6bdf3fd1, 0x00010004,\
 201                     0x00151820, 0xe6c00002, 0x08000240, 0x08000240}
 202
 203 #define REG_PARM_STACK_SPACE 16
 204
 205 /* If we've reached a trap instruction within the call dummy, then
 206    we'll consider that to mean that we've reached the call dummy's
 207    end after its successful completion. */
 208 #define CALL_DUMMY_HAS_COMPLETED(pc, sp, frame_address) \
 209   (DEPRECATED_PC_IN_CALL_DUMMY((pc), (sp), (frame_address)) && \
 210    (read_memory_integer((pc), 4) == BREAKPOINT32))
 211
 212 /* Insert the specified number of args and function address into a
 213    call sequence of the above form stored at DUMMYNAME.
 214
 215    On the hppa we need to call the stack dummy through $$dyncall.
 216    Therefore our version of DEPRECATED_FIX_CALL_DUMMY takes an extra
 217    argument, real_pc, which is the location where gdb should start up
 218    the inferior to do the function call.  */
 219
 220 /* FIXME: brobecker 2002-12-26.  This macro is going to cause us some
 221    problems before we can go to multiarch partial as it has been
 222    diverted on HPUX to return the value of the PC!  */
 223 /* NOTE: cagney/2003-05-03: This has been replaced by push_dummy_code.
 224    Hopefully that has all the parameters HP/UX needs.  */
 225 #define DEPRECATED_FIX_CALL_DUMMY hppa_fix_call_dummy
 226 extern CORE_ADDR hppa_fix_call_dummy (char *, CORE_ADDR, CORE_ADDR, int,
 227                                       struct value **, struct type *, int);
 228
 229 #define GDB_TARGET_IS_HPPA
 230
 231 /*
 232  * Unwind table and descriptor.
 233  */
 234
 235 struct unwind_table_entry
 236   {
 237     CORE_ADDR region_start;
 238     CORE_ADDR region_end;
 239
 240     unsigned int Cannot_unwind:1;       /* 0 */
 241     unsigned int Millicode:1;   /* 1 */
 242     unsigned int Millicode_save_sr0:1;  /* 2 */
 243     unsigned int Region_description:2;  /* 3..4 */
 244     unsigned int reserved1:1;   /* 5 */
 245     unsigned int Entry_SR:1;    /* 6 */
 246     unsigned int Entry_FR:4;    /* number saved *//* 7..10 */
 247     unsigned int Entry_GR:5;    /* number saved *//* 11..15 */
 248     unsigned int Args_stored:1; /* 16 */
 249     unsigned int Variable_Frame:1;      /* 17 */
 250     unsigned int Separate_Package_Body:1;       /* 18 */
 251     unsigned int Frame_Extension_Millicode:1;   /* 19 */
 252     unsigned int Stack_Overflow_Check:1;        /* 20 */
 253     unsigned int Two_Instruction_SP_Increment:1;        /* 21 */
 254     unsigned int Ada_Region:1;  /* 22 */
 255     unsigned int cxx_info:1;    /* 23 */
 256     unsigned int cxx_try_catch:1;       /* 24 */
 257     unsigned int sched_entry_seq:1;     /* 25 */
 258     unsigned int reserved2:1;   /* 26 */
 259     unsigned int Save_SP:1;     /* 27 */
 260     unsigned int Save_RP:1;     /* 28 */
 261     unsigned int Save_MRP_in_frame:1;   /* 29 */
 262     unsigned int extn_ptr_defined:1;    /* 30 */
 263     unsigned int Cleanup_defined:1;     /* 31 */
 264
 265     unsigned int MPE_XL_interrupt_marker:1;     /* 0 */
 266     unsigned int HP_UX_interrupt_marker:1;      /* 1 */
 267     unsigned int Large_frame:1; /* 2 */
 268     unsigned int Pseudo_SP_Set:1;       /* 3 */
 269     unsigned int reserved4:1;   /* 4 */
 270     unsigned int Total_frame_size:27;   /* 5..31 */
 271
 272     /* This is *NOT* part of an actual unwind_descriptor in an object
 273        file.  It is *ONLY* part of the "internalized" descriptors that
 274        we create from those in a file.
 275      */
 276     struct
 277       {
 278         unsigned int stub_type:4;       /* 0..3 */
 279         unsigned int padding:28;        /* 4..31 */
 280       }
 281     stub_unwind;
 282   };
 283
 284 /* HP linkers also generate unwinds for various linker-generated stubs.
 285    GDB reads in the stubs from the $UNWIND_END$ subspace, then
 286    "converts" them into normal unwind entries using some of the reserved
 287    fields to store the stub type.  */
 288
 289 /* The gaps represent linker stubs used in MPE and space for future
 290    expansion.  */
 291 enum unwind_stub_types
 292   {
 293     LONG_BRANCH = 1,
 294     PARAMETER_RELOCATION = 2,
 295     EXPORT = 10,
 296     IMPORT = 11,
 297     IMPORT_SHLIB = 12,
 298   };
 299
 300 /* We use the objfile->obj_private pointer for two things:
 301
 302  * 1.  An unwind table;
 303  *
 304  * 2.  A pointer to any associated shared library object.
 305  *
 306  * #defines are used to help refer to these objects.
 307  */
 308
 309 /* Info about the unwind table associated with an object file.
 310
 311  * This is hung off of the "objfile->obj_private" pointer, and
 312  * is allocated in the objfile's psymbol obstack.  This allows
 313  * us to have unique unwind info for each executable and shared
 314  * library that we are debugging.
 315  */
 316 struct obj_unwind_info
 317   {
 318     struct unwind_table_entry *table;   /* Pointer to unwind info */
 319     struct unwind_table_entry *cache;   /* Pointer to last entry we found */
 320     int last;                   /* Index of last entry */
 321   };
 322
 323 typedef struct obj_private_struct
 324   {
 325     struct obj_unwind_info *unwind_info;        /* a pointer */
 326     struct so_list *so_info;    /* a pointer  */
 327     CORE_ADDR dp;
 328   }
 329 obj_private_data_t;
 330
 331 /* For a number of horrible reasons we may have to adjust the location
 332    of variables on the stack.  Ugh.  */
 333 #define HPREAD_ADJUST_STACK_ADDRESS(ADDR) hpread_adjust_stack_address(ADDR)
 334 extern int hpread_adjust_stack_address (CORE_ADDR);
 335
 336 /* Here's how to step off a permanent breakpoint.  */
 337 #define SKIP_PERMANENT_BREAKPOINT (hppa_skip_permanent_breakpoint)
 338 extern void hppa_skip_permanent_breakpoint (void);
 339
 340 /* On HP-UX, certain system routines (millicode) have names beginning
 341    with $ or $$, e.g. $$dyncall, which handles inter-space procedure
 342    calls on PA-RISC.  Tell the expression parser to check for those
 343    when parsing tokens that begin with "$".  */
 344 #define SYMBOLS_CAN_START_WITH_DOLLAR (1)