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