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