OSDN Git Service

Index: ChangeLog
[pf3gnuchains/pf3gnuchains3x.git] / 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 #define GDB_MULTI_ARCH 0
28
29 /* NOTE: cagney/2002-11-24: This is a guess.  */
30 #define DEPRECATED_USE_GENERIC_DUMMY_FRAMES 0
31 #define CALL_DUMMY_LOCATION ON_STACK
32 #define DEPRECATED_PC_IN_CALL_DUMMY(pc, sp, frame_address) deprecated_pc_in_call_dummy_on_stack (pc, sp, frame_address)
33 #define DEPRECATED_INIT_FRAME_PC(l,f) (init_frame_pc_default (l, f))
34
35 /* Forward declarations of some types we use in prototypes */
36
37 struct frame_info;
38 struct frame_saved_regs;
39 struct value;
40 struct type;
41 struct inferior_status;
42
43 /* By default assume we don't have to worry about software floating point.  */
44 #ifndef SOFT_FLOAT
45 #define SOFT_FLOAT 0
46 #endif
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 #if !GDB_MULTI_ARCH
62 extern int hppa_reg_struct_has_addr (int gcc_p, struct type *type);
63 #define REG_STRUCT_HAS_ADDR(gcc_p,type) hppa_reg_struct_has_addr (gcc_p,type)
64 #endif
65
66 /* Offset from address of function to start of its code.
67    Zero on most machines.  */
68
69 #if !GDB_MULTI_ARCH
70 #define FUNCTION_START_OFFSET 0
71 #endif
72
73 /* Advance PC across any function entry prologue instructions
74    to reach some "real" code.  */
75
76 #if !GDB_MULTI_ARCH
77 extern CORE_ADDR hppa_skip_prologue (CORE_ADDR);
78 #define SKIP_PROLOGUE(pc) (hppa_skip_prologue (pc))
79 #endif
80
81 /* If PC is in some function-call trampoline code, return the PC
82    where the function itself actually starts.  If not, return NULL.  */
83
84 #if !GDB_MULTI_ARCH
85 #define SKIP_TRAMPOLINE_CODE(pc) hppa_skip_trampoline_code (pc)
86 extern CORE_ADDR hppa_skip_trampoline_code (CORE_ADDR);
87 #endif
88
89 /* Return non-zero if we are in an appropriate trampoline. */
90
91 #if !GDB_MULTI_ARCH
92 #define IN_SOLIB_CALL_TRAMPOLINE(pc, name) \
93    hppa_in_solib_call_trampoline (pc, name)
94 extern int hppa_in_solib_call_trampoline (CORE_ADDR, char *);
95 #endif
96
97 #if !GDB_MULTI_ARCH
98 #define IN_SOLIB_RETURN_TRAMPOLINE(pc, name) \
99   hppa_in_solib_return_trampoline (pc, name)
100 extern int hppa_in_solib_return_trampoline (CORE_ADDR, char *);
101 #endif
102
103 #if !GDB_MULTI_ARCH
104 #undef  SAVED_PC_AFTER_CALL
105 #define SAVED_PC_AFTER_CALL(frame) hppa_saved_pc_after_call (frame)
106 extern CORE_ADDR hppa_saved_pc_after_call (struct frame_info *);
107 #endif
108
109 #if !GDB_MULTI_ARCH
110 extern int hppa_inner_than (CORE_ADDR lhs, CORE_ADDR rhs);
111 #define INNER_THAN(lhs,rhs) hppa_inner_than(lhs,rhs)
112 #endif
113
114 #if !GDB_MULTI_ARCH
115 extern CORE_ADDR hppa_stack_align (CORE_ADDR sp);
116 #define STACK_ALIGN(sp) hppa_stack_align (sp)
117 #endif
118
119 #if !GDB_MULTI_ARCH
120 #define EXTRA_STACK_ALIGNMENT_NEEDED 0
121 #endif
122
123 /* Sequence of bytes for breakpoint instruction.  */
124
125 #define BREAKPOINT {0x00, 0x01, 0x00, 0x04}
126 #define BREAKPOINT32 0x10004
127
128 /* Amount PC must be decremented by after a breakpoint.
129    This is often the number of bytes in BREAKPOINT
130    but not always.
131
132    Not on the PA-RISC */
133
134 #if !GDB_MULTI_ARCH
135 #define DECR_PC_AFTER_BREAK 0
136 #endif
137
138 extern int hppa_pc_requires_run_before_use (CORE_ADDR pc);
139 #define PC_REQUIRES_RUN_BEFORE_USE(pc) hppa_pc_requires_run_before_use (pc)
140
141 /* Say how long (ordinary) registers are.  This is a piece of bogosity
142    used in push_word and a few other places; REGISTER_RAW_SIZE is the
143    real way to know how big a register is.  */
144
145 #if !GDB_MULTI_ARCH
146 #define REGISTER_SIZE 4
147 #endif
148
149 /* Number of machine registers */
150
151 #if !GDB_MULTI_ARCH
152 #define NUM_REGS 128
153 #endif
154
155 /* Initializer for an array of names of registers.
156    There should be NUM_REGS strings in this initializer.
157    They are in rows of eight entries  */
158
159 #define REGISTER_NAMES  \
160  {"flags",  "r1",      "rp",      "r3",    "r4",     "r5",      "r6",     "r7",    \
161   "r8",     "r9",      "r10",     "r11",   "r12",    "r13",     "r14",    "r15",   \
162   "r16",    "r17",     "r18",     "r19",   "r20",    "r21",     "r22",    "r23",   \
163   "r24",    "r25",     "r26",     "dp",    "ret0",   "ret1",    "sp",     "r31",   \
164   "sar",    "pcoqh",   "pcsqh",   "pcoqt", "pcsqt",  "eiem",    "iir",    "isr",   \
165   "ior",    "ipsw",    "goto",    "sr4",   "sr0",    "sr1",     "sr2",    "sr3",   \
166   "sr5",    "sr6",     "sr7",     "cr0",   "cr8",    "cr9",     "ccr",    "cr12",  \
167   "cr13",   "cr24",    "cr25",    "cr26",  "mpsfu_high","mpsfu_low","mpsfu_ovflo","pad",\
168   "fpsr",    "fpe1",   "fpe2",    "fpe3",  "fpe4",   "fpe5",    "fpe6",   "fpe7",  \
169   "fr4",     "fr4R",   "fr5",     "fr5R",  "fr6",    "fr6R",    "fr7",    "fr7R",  \
170   "fr8",     "fr8R",   "fr9",     "fr9R",  "fr10",   "fr10R",   "fr11",   "fr11R", \
171   "fr12",    "fr12R",  "fr13",    "fr13R", "fr14",   "fr14R",   "fr15",   "fr15R", \
172   "fr16",    "fr16R",  "fr17",    "fr17R", "fr18",   "fr18R",   "fr19",   "fr19R", \
173   "fr20",    "fr20R",  "fr21",    "fr21R", "fr22",   "fr22R",   "fr23",   "fr23R", \
174   "fr24",    "fr24R",  "fr25",    "fr25R", "fr26",   "fr26R",   "fr27",   "fr27R", \
175   "fr28",    "fr28R",  "fr29",    "fr29R", "fr30",   "fr30R",   "fr31",   "fr31R"}
176
177 /* Register numbers of various important registers.
178    Note that some of these values are "real" register numbers,
179    and correspond to the general registers of the machine,
180    and some are "phony" register numbers which are too large
181    to be actual register numbers as far as the user is concerned
182    but do serve to get the desired values when passed to read_register.  */
183
184 #define R0_REGNUM 0             /* Doesn't actually exist, used as base for
185                                    other r registers.  */
186 #define FLAGS_REGNUM 0          /* Various status flags */
187 #define RP_REGNUM 2             /* return pointer */
188 #if !GDB_MULTI_ARCH
189 #define FP_REGNUM 3             /* Contains address of executing stack */
190                                 /* frame */
191 #endif
192 #if !GDB_MULTI_ARCH
193 #define SP_REGNUM 30            /* Contains address of top of stack */
194 #endif
195 #define SAR_REGNUM 32           /* Shift Amount Register */
196 #define IPSW_REGNUM 41          /* Interrupt Processor Status Word */
197 #define PCOQ_HEAD_REGNUM 33     /* instruction offset queue head */
198 #define PCSQ_HEAD_REGNUM 34     /* instruction space queue head */
199 #define PCOQ_TAIL_REGNUM 35     /* instruction offset queue tail */
200 #define PCSQ_TAIL_REGNUM 36     /* instruction space queue tail */
201 #define EIEM_REGNUM 37          /* External Interrupt Enable Mask */
202 #define IIR_REGNUM 38           /* Interrupt Instruction Register */
203 #define IOR_REGNUM 40           /* Interrupt Offset Register */
204 #define SR4_REGNUM 43           /* space register 4 */
205 #define RCR_REGNUM 51           /* Recover Counter (also known as cr0) */
206 #define CCR_REGNUM 54           /* Coprocessor Configuration Register */
207 #define TR0_REGNUM 57           /* Temporary Registers (cr24 -> cr31) */
208 #define CR27_REGNUM 60          /* Base register for thread-local storage, cr27 */
209 #if !GDB_MULTI_ARCH
210 #define FP0_REGNUM 64           /* floating point reg. 0 (fspr) */
211 #endif
212 #define FP4_REGNUM 72
213
214 #define ARG0_REGNUM 26          /* The first argument of a callee. */
215 #define ARG1_REGNUM 25          /* The second argument of a callee. */
216 #define ARG2_REGNUM 24          /* The third argument of a callee. */
217 #define ARG3_REGNUM 23          /* The fourth argument of a callee. */
218
219 /* compatibility with the rest of gdb. */
220 #if !GDB_MULTI_ARCH
221 #define PC_REGNUM PCOQ_HEAD_REGNUM
222 #endif
223 #if !GDB_MULTI_ARCH
224 #define NPC_REGNUM PCOQ_TAIL_REGNUM
225 #endif
226
227 /*
228  * Processor Status Word Masks
229  */
230
231 #define PSW_T   0x01000000      /* Taken Branch Trap Enable */
232 #define PSW_H   0x00800000      /* Higher-Privilege Transfer Trap Enable */
233 #define PSW_L   0x00400000      /* Lower-Privilege Transfer Trap Enable */
234 #define PSW_N   0x00200000      /* PC Queue Front Instruction Nullified */
235 #define PSW_X   0x00100000      /* Data Memory Break Disable */
236 #define PSW_B   0x00080000      /* Taken Branch in Previous Cycle */
237 #define PSW_C   0x00040000      /* Code Address Translation Enable */
238 #define PSW_V   0x00020000      /* Divide Step Correction */
239 #define PSW_M   0x00010000      /* High-Priority Machine Check Disable */
240 #define PSW_CB  0x0000ff00      /* Carry/Borrow Bits */
241 #define PSW_R   0x00000010      /* Recovery Counter Enable */
242 #define PSW_Q   0x00000008      /* Interruption State Collection Enable */
243 #define PSW_P   0x00000004      /* Protection ID Validation Enable */
244 #define PSW_D   0x00000002      /* Data Address Translation Enable */
245 #define PSW_I   0x00000001      /* External, Power Failure, Low-Priority */
246                                 /* Machine Check Interruption Enable */
247
248 /* When fetching register values from an inferior or a core file,
249    clean them up using this macro.  BUF is a char pointer to
250    the raw value of the register in the registers[] array.  */
251
252 #define DEPRECATED_CLEAN_UP_REGISTER_VALUE(regno, buf) \
253   do {  \
254     if ((regno) == PCOQ_HEAD_REGNUM || (regno) == PCOQ_TAIL_REGNUM) \
255       (buf)[sizeof(CORE_ADDR) -1] &= ~0x3; \
256   } while (0)
257
258 /* Define DEPRECATED_DO_REGISTERS_INFO() to do machine-specific
259    formatting of register dumps. */
260
261 #define DEPRECATED_DO_REGISTERS_INFO(_regnum, fp) pa_do_registers_info (_regnum, fp)
262 extern void pa_do_registers_info (int, int);
263
264 #if 0
265 #define STRCAT_REGISTER(regnum, fpregs, stream, precision) pa_do_strcat_registers_info (regnum, fpregs, stream, precision)
266 extern void pa_do_strcat_registers_info (int, int, struct ui_file *, enum precision_type);
267 #endif
268
269 /* PA specific macro to see if the current instruction is nullified. */
270 #ifndef INSTRUCTION_NULLIFIED
271 extern int hppa_instruction_nullified (void);
272 #define INSTRUCTION_NULLIFIED hppa_instruction_nullified ()
273 #endif
274
275 /* Number of bytes of storage in the actual machine representation
276    for register N.  On the PA-RISC, all regs are 4 bytes, including
277    the FP registers (they're accessed as two 4 byte halves).  */
278
279 #if !GDB_MULTI_ARCH
280 extern int hppa_register_raw_size (int reg_nr);
281 #define REGISTER_RAW_SIZE(N) hppa_register_raw_size (N)
282 #endif
283
284 /* Total amount of space needed to store our copies of the machine's
285    register state, the array `registers'.  */
286 #if !GDB_MULTI_ARCH
287 #define REGISTER_BYTES (NUM_REGS * 4)
288 #endif
289
290 #if !GDB_MULTI_ARCH
291 extern int hppa_register_byte (int reg_nr);
292 #define REGISTER_BYTE(N) hppa_register_byte (N)
293 #endif
294
295 /* Number of bytes of storage in the program's representation
296    for register N. */
297
298 #if !GDB_MULTI_ARCH
299 #define REGISTER_VIRTUAL_SIZE(N) REGISTER_RAW_SIZE(N)
300 #endif
301
302 /* Largest value REGISTER_RAW_SIZE can have.  */
303
304 #if !GDB_MULTI_ARCH
305 #define DEPRECATED_MAX_REGISTER_RAW_SIZE 4
306 #endif
307
308 /* Largest value REGISTER_VIRTUAL_SIZE can have.  */
309
310 #if !GDB_MULTI_ARCH
311 #define DEPRECATED_MAX_REGISTER_VIRTUAL_SIZE 8
312 #endif
313
314 #if !GDB_MULTI_ARCH
315 extern struct type * hppa_register_virtual_type (int reg_nr);
316 #define REGISTER_VIRTUAL_TYPE(N) hppa_register_virtual_type (N)
317 #endif
318
319 #if !GDB_MULTI_ARCH
320 extern void hppa_store_struct_return (CORE_ADDR addr, CORE_ADDR sp);
321 #define STORE_STRUCT_RETURN(ADDR, SP) hppa_store_struct_return (ADDR, SP)
322 #endif
323
324 /* Extract from an array REGBUF containing the (raw) register state
325    a function return value of type TYPE, and copy that, in virtual format,
326    into VALBUF.  */
327
328 #if !GDB_MULTI_ARCH
329 void hppa_extract_return_value (struct type *type, char *regbuf, char *valbuf);
330 #define DEPRECATED_EXTRACT_RETURN_VALUE(TYPE,REGBUF,VALBUF) \
331   hppa_extract_return_value (TYPE, REGBUF, VALBUF);
332 #endif
333
334  /* elz: decide whether the function returning a value of type type
335     will put it on the stack or in the registers.
336     The pa calling convention says that:
337     register 28 (called ret0 by gdb) contains any ASCII char,
338     and any non_floating point value up to 32-bits.
339     reg 28 and 29 contain non-floating point up tp 64 bits and larger
340     than 32 bits. (higer order word in reg 28).
341     fr4: floating point up to 64 bits
342     sr1: space identifier (32-bit)
343     stack: any lager than 64-bit, with the address in r28
344   */
345 #if !GDB_MULTI_ARCH
346 extern use_struct_convention_fn hppa_use_struct_convention;
347 #define USE_STRUCT_CONVENTION(gcc_p,type) hppa_use_struct_convention (gcc_p,type)
348 #endif
349
350 /* Write into appropriate registers a function return value
351    of type TYPE, given in virtual format.  */
352
353 #if !GDB_MULTI_ARCH
354 extern void hppa_store_return_value (struct type *type, char *valbuf);
355 #define DEPRECATED_STORE_RETURN_VALUE(TYPE,VALBUF) \
356   hppa_store_return_value (TYPE, VALBUF);
357 #endif
358
359 #if !GDB_MULTI_ARCH
360 extern CORE_ADDR hppa_extract_struct_value_address (char *regbuf);
361 #define DEPRECATED_EXTRACT_STRUCT_VALUE_ADDRESS(REGBUF) \
362   hppa_extract_struct_value_address (REGBUF)
363 #endif
364
365 /* elz: Return a large value, which is stored on the stack at addr.
366    This is defined only for the hppa, at this moment.  The above macro
367    DEPRECATED_EXTRACT_STRUCT_VALUE_ADDRESS is not called anymore,
368    because it assumes that on exit from a called function which
369    returns a large structure on the stack, the address of the ret
370    structure is still in register 28. Unfortunately this register is
371    usually overwritten by the called function itself, on hppa. This is
372    specified in the calling convention doc. As far as I know, the only
373    way to get the return value is to have the caller tell us where it
374    told the callee to put it, rather than have the callee tell us.  */
375 struct value *hppa_value_returned_from_stack (register struct type *valtype,
376                                               CORE_ADDR addr);
377 #define VALUE_RETURNED_FROM_STACK(valtype,addr) \
378   hppa_value_returned_from_stack (valtype, addr)
379
380 #if !GDB_MULTI_ARCH
381 extern int hppa_cannot_store_register (int regnum);
382 #define CANNOT_STORE_REGISTER(regno) hppa_cannot_store_register (regno)
383 #endif
384
385 #if !GDB_MULTI_ARCH
386 #define DEPRECATED_INIT_EXTRA_FRAME_INFO(fromleaf, frame) hppa_init_extra_frame_info (fromleaf, frame)
387 extern void hppa_init_extra_frame_info (int, struct frame_info *);
388 #endif
389
390 /* Describe the pointer in each stack frame to the previous stack frame
391    (its caller).  */
392
393 /* DEPRECATED_FRAME_CHAIN takes a frame's nominal address and produces
394    the frame's chain-pointer.  */
395
396 /* In the case of the PA-RISC, the frame's nominal address
397    is the address of a 4-byte word containing the calling frame's
398    address (previous FP).  */
399
400 #if !GDB_MULTI_ARCH
401 #define DEPRECATED_FRAME_CHAIN(thisframe) hppa_frame_chain (thisframe)
402 extern CORE_ADDR hppa_frame_chain (struct frame_info *);
403 #endif
404
405 #if !GDB_MULTI_ARCH
406 extern int hppa_frame_chain_valid (CORE_ADDR, struct frame_info *);
407 #define DEPRECATED_FRAME_CHAIN_VALID(chain, thisframe) hppa_frame_chain_valid (chain, thisframe)
408 #endif
409
410 /* Define other aspects of the stack frame.  */
411
412 /* A macro that tells us whether the function invocation represented
413    by FI does not have a frame on the stack associated with it.  If it
414    does not, FRAMELESS is set to 1, else 0.  */
415 #if !GDB_MULTI_ARCH
416 #define FRAMELESS_FUNCTION_INVOCATION(FI) \
417   (hppa_frameless_function_invocation (FI))
418 extern int hppa_frameless_function_invocation (struct frame_info *);
419 #endif
420
421 #if !GDB_MULTI_ARCH
422 extern CORE_ADDR hppa_frame_saved_pc (struct frame_info *frame);
423 #define DEPRECATED_FRAME_SAVED_PC(FRAME) hppa_frame_saved_pc (FRAME)
424 #endif
425
426 #if !GDB_MULTI_ARCH
427 extern CORE_ADDR hppa_frame_args_address (struct frame_info *fi);
428 #define FRAME_ARGS_ADDRESS(fi) hppa_frame_args_address (fi)
429 #endif
430
431 #if !GDB_MULTI_ARCH
432 extern CORE_ADDR hppa_frame_locals_address (struct frame_info *fi);
433 #define FRAME_LOCALS_ADDRESS(fi) hppa_frame_locals_address (fi)
434 #endif
435
436 #if !GDB_MULTI_ARCH
437 extern int hppa_frame_num_args (struct frame_info *frame);
438 #define FRAME_NUM_ARGS(fi) hppa_frame_num_args (fi)
439 #endif
440
441 #if !GDB_MULTI_ARCH
442 #define FRAME_ARGS_SKIP 0
443 #endif
444
445 #define FRAME_FIND_SAVED_REGS(frame_info, frame_saved_regs) \
446   hppa_frame_find_saved_regs (frame_info, &frame_saved_regs)
447 extern void hppa_frame_find_saved_regs (struct frame_info *,
448                                         struct frame_saved_regs *);
449 \f
450
451 /* Things needed for making the inferior call functions.  */
452
453 #if !GDB_MULTI_ARCH
454 #define DEPRECATED_PUSH_DUMMY_FRAME hppa_push_dummy_frame ()
455 extern void hppa_push_dummy_frame (void);
456 #endif
457
458 /* Discard from the stack the innermost frame, 
459    restoring all saved registers.  */
460 #if !GDB_MULTI_ARCH
461 #define DEPRECATED_POP_FRAME  hppa_pop_frame ()
462 extern void hppa_pop_frame (void);
463 #endif
464
465 #define INSTRUCTION_SIZE 4
466
467 #ifndef PA_LEVEL_0
468
469 /* Non-level zero PA's have space registers (but they don't always have
470    floating-point, do they????  */
471
472 /* This sequence of words is the instructions
473
474    ; Call stack frame has already been built by gdb. Since we could be calling 
475    ; a varargs function, and we do not have the benefit of a stub to put things in
476    ; the right place, we load the first 4 word of arguments into both the general
477    ; and fp registers.
478    call_dummy
479    ldw -36(sp), arg0
480    ldw -40(sp), arg1
481    ldw -44(sp), arg2
482    ldw -48(sp), arg3
483    ldo -36(sp), r1
484    fldws 0(0, r1), fr4
485    fldds -4(0, r1), fr5
486    fldws -8(0, r1), fr6
487    fldds -12(0, r1), fr7
488    ldil 0, r22                  ; FUNC_LDIL_OFFSET must point here
489    ldo 0(r22), r22                      ; FUNC_LDO_OFFSET must point here
490    ldsid (0,r22), r4
491    ldil 0, r1                   ; SR4EXPORT_LDIL_OFFSET must point here
492    ldo 0(r1), r1                        ; SR4EXPORT_LDO_OFFSET must point here
493    ldsid (0,r1), r20
494    combt,=,n r4, r20, text_space        ; If target is in data space, do a
495    ble 0(sr5, r22)                      ; "normal" procedure call
496    copy r31, r2
497    break 4, 8 
498    mtsp r21, sr0
499    ble,n 0(sr0, r22)
500    text_space                           ; Otherwise, go through _sr4export,
501    ble (sr4, r1)                        ; which will return back here.
502    stw r31,-24(r30)
503    break 4, 8
504    mtsp r21, sr0
505    ble,n 0(sr0, r22)
506    nop                          ; To avoid kernel bugs 
507    nop                          ; and keep the dummy 8 byte aligned
508
509    The dummy decides if the target is in text space or data space. If
510    it's in data space, there's no problem because the target can
511    return back to the dummy. However, if the target is in text space,
512    the dummy calls the secret, undocumented routine _sr4export, which
513    calls a function in text space and can return to any space. Instead
514    of including fake instructions to represent saved registers, we
515    know that the frame is associated with the call dummy and treat it
516    specially.
517
518    The trailing NOPs are needed to avoid a bug in HPUX, BSD and OSF1 
519    kernels.   If the memory at the location pointed to by the PC is
520    0xffffffff then a ptrace step call will fail (even if the instruction
521    is nullified).
522
523    The code to pop a dummy frame single steps three instructions
524    starting with the last mtsp.  This includes the nullified "instruction"
525    following the ble (which is uninitialized junk).  If the 
526    "instruction" following the last BLE is 0xffffffff, then the ptrace
527    will fail and the dummy frame is not correctly popped.
528
529    By placing a NOP in the delay slot of the BLE instruction we can be 
530    sure that we never try to execute a 0xffffffff instruction and
531    avoid the kernel bug.  The second NOP is needed to keep the call
532    dummy 8 byte aligned.  */
533
534 /* Define offsets into the call dummy for the target function address */
535 #define FUNC_LDIL_OFFSET (INSTRUCTION_SIZE * 9)
536 #define FUNC_LDO_OFFSET (INSTRUCTION_SIZE * 10)
537
538 /* Define offsets into the call dummy for the _sr4export address */
539 #define SR4EXPORT_LDIL_OFFSET (INSTRUCTION_SIZE * 12)
540 #define SR4EXPORT_LDO_OFFSET (INSTRUCTION_SIZE * 13)
541
542 #define CALL_DUMMY {0x4BDA3FB9, 0x4BD93FB1, 0x4BD83FA9, 0x4BD73FA1,\
543                     0x37C13FB9, 0x24201004, 0x2C391005, 0x24311006,\
544                     0x2C291007, 0x22C00000, 0x36D60000, 0x02C010A4,\
545                     0x20200000, 0x34210000, 0x002010b4, 0x82842022,\
546                     0xe6c06000, 0x081f0242, 0x00010004, 0x00151820,\
547                     0xe6c00002, 0xe4202000, 0x6bdf3fd1, 0x00010004,\
548                     0x00151820, 0xe6c00002, 0x08000240, 0x08000240}
549
550 #if !GDB_MULTI_ARCH
551 #define CALL_DUMMY_LENGTH (INSTRUCTION_SIZE * 28)
552 #endif
553 #define REG_PARM_STACK_SPACE 16
554
555 #else /* defined PA_LEVEL_0 */
556
557 /* FIXME: brobecker 2002-12-26.  PA_LEVEL_0 is only defined for the
558    hppa-pro target, which should be obsoleted soon.  The following
559    section will therefore not be included in the multiarch conversion.  */
560 /* This is the call dummy for a level 0 PA.  Level 0's don't have space
561    registers (or floating point?), so we skip all that inter-space call stuff,
562    and avoid touching the fp regs.
563
564    call_dummy
565
566    ldw -36(%sp), %arg0
567    ldw -40(%sp), %arg1
568    ldw -44(%sp), %arg2
569    ldw -48(%sp), %arg3
570    ldil 0, %r31                 ; FUNC_LDIL_OFFSET must point here
571    ldo 0(%r31), %r31            ; FUNC_LDO_OFFSET must point here
572    ble 0(%sr0, %r31)
573    copy %r31, %r2
574    break 4, 8 
575    nop                          ; restore_pc_queue expects these
576    bv,n 0(%r22)                 ; instructions to be here...
577    nop
578  */
579
580 /* Define offsets into the call dummy for the target function address */
581 #define FUNC_LDIL_OFFSET (INSTRUCTION_SIZE * 4)
582 #define FUNC_LDO_OFFSET (INSTRUCTION_SIZE * 5)
583
584 #define CALL_DUMMY {0x4bda3fb9, 0x4bd93fb1, 0x4bd83fa9, 0x4bd73fa1,\
585                     0x23e00000, 0x37ff0000, 0xe7e00000, 0x081f0242,\
586                     0x00010004, 0x08000240, 0xeac0c002, 0x08000240}
587
588 #define CALL_DUMMY_LENGTH (INSTRUCTION_SIZE * 12)
589
590 #endif /* defined PA_LEVEL_0 */
591
592 #if !GDB_MULTI_ARCH
593 #define CALL_DUMMY_START_OFFSET 0
594 #endif
595
596 /* If we've reached a trap instruction within the call dummy, then
597    we'll consider that to mean that we've reached the call dummy's
598    end after its successful completion. */
599 #define CALL_DUMMY_HAS_COMPLETED(pc, sp, frame_address) \
600   (DEPRECATED_PC_IN_CALL_DUMMY((pc), (sp), (frame_address)) && \
601    (read_memory_integer((pc), 4) == BREAKPOINT32))
602
603 /*
604  * Insert the specified number of args and function address
605  * into a call sequence of the above form stored at DUMMYNAME.
606  *
607  * On the hppa we need to call the stack dummy through $$dyncall.
608  * Therefore our version of FIX_CALL_DUMMY takes an extra argument,
609  * real_pc, which is the location where gdb should start up the
610  * inferior to do the function call.
611  */
612
613 /* FIXME: brobecker 2002-12-26.  This macro is going to cause us some
614    problems before we can go to multiarch partial as it has been diverted
615    on HPUX to return the value of the PC!  */
616 #define FIX_CALL_DUMMY hppa_fix_call_dummy
617 extern CORE_ADDR hppa_fix_call_dummy (char *, CORE_ADDR, CORE_ADDR, int,
618                                       struct value **, struct type *, int);
619
620 #if !GDB_MULTI_ARCH
621 #define PUSH_ARGUMENTS(nargs, args, sp, struct_return, struct_addr) \
622   (hppa_push_arguments((nargs), (args), (sp), (struct_return), (struct_addr)))
623 extern CORE_ADDR hppa_push_arguments (int, struct value **, CORE_ADDR, int,
624                                       CORE_ADDR);
625 #endif
626
627 \f
628 #if !GDB_MULTI_ARCH
629 extern CORE_ADDR hppa_smash_text_address (CORE_ADDR addr);
630 #define SMASH_TEXT_ADDRESS(addr) hppa_smash_text_address (addr)
631 #endif
632
633 #define GDB_TARGET_IS_HPPA
634
635 #if !GDB_MULTI_ARCH
636 #define BELIEVE_PCC_PROMOTION 1
637 #endif
638
639 /*
640  * Unwind table and descriptor.
641  */
642
643 struct unwind_table_entry
644   {
645     CORE_ADDR region_start;
646     CORE_ADDR region_end;
647
648     unsigned int Cannot_unwind:1;       /* 0 */
649     unsigned int Millicode:1;   /* 1 */
650     unsigned int Millicode_save_sr0:1;  /* 2 */
651     unsigned int Region_description:2;  /* 3..4 */
652     unsigned int reserved1:1;   /* 5 */
653     unsigned int Entry_SR:1;    /* 6 */
654     unsigned int Entry_FR:4;    /* number saved *//* 7..10 */
655     unsigned int Entry_GR:5;    /* number saved *//* 11..15 */
656     unsigned int Args_stored:1; /* 16 */
657     unsigned int Variable_Frame:1;      /* 17 */
658     unsigned int Separate_Package_Body:1;       /* 18 */
659     unsigned int Frame_Extension_Millicode:1;   /* 19 */
660     unsigned int Stack_Overflow_Check:1;        /* 20 */
661     unsigned int Two_Instruction_SP_Increment:1;        /* 21 */
662     unsigned int Ada_Region:1;  /* 22 */
663     unsigned int cxx_info:1;    /* 23 */
664     unsigned int cxx_try_catch:1;       /* 24 */
665     unsigned int sched_entry_seq:1;     /* 25 */
666     unsigned int reserved2:1;   /* 26 */
667     unsigned int Save_SP:1;     /* 27 */
668     unsigned int Save_RP:1;     /* 28 */
669     unsigned int Save_MRP_in_frame:1;   /* 29 */
670     unsigned int extn_ptr_defined:1;    /* 30 */
671     unsigned int Cleanup_defined:1;     /* 31 */
672
673     unsigned int MPE_XL_interrupt_marker:1;     /* 0 */
674     unsigned int HP_UX_interrupt_marker:1;      /* 1 */
675     unsigned int Large_frame:1; /* 2 */
676     unsigned int Pseudo_SP_Set:1;       /* 3 */
677     unsigned int reserved4:1;   /* 4 */
678     unsigned int Total_frame_size:27;   /* 5..31 */
679
680     /* This is *NOT* part of an actual unwind_descriptor in an object
681        file.  It is *ONLY* part of the "internalized" descriptors that
682        we create from those in a file.
683      */
684     struct
685       {
686         unsigned int stub_type:4;       /* 0..3 */
687         unsigned int padding:28;        /* 4..31 */
688       }
689     stub_unwind;
690   };
691
692 /* HP linkers also generate unwinds for various linker-generated stubs.
693    GDB reads in the stubs from the $UNWIND_END$ subspace, then 
694    "converts" them into normal unwind entries using some of the reserved
695    fields to store the stub type.  */
696
697 struct stub_unwind_entry
698   {
699     /* The offset within the executable for the associated stub.  */
700     unsigned stub_offset;
701
702     /* The type of stub this unwind entry describes.  */
703     char type;
704
705     /* Unknown.  Not needed by GDB at this time.  */
706     char prs_info;
707
708     /* Length (in instructions) of the associated stub.  */
709     short stub_length;
710   };
711
712 /* Sizes (in bytes) of the native unwind entries.  */
713 #define UNWIND_ENTRY_SIZE 16
714 #define STUB_UNWIND_ENTRY_SIZE 8
715
716 /* The gaps represent linker stubs used in MPE and space for future
717    expansion.  */
718 enum unwind_stub_types
719   {
720     LONG_BRANCH = 1,
721     PARAMETER_RELOCATION = 2,
722     EXPORT = 10,
723     IMPORT = 11,
724     IMPORT_SHLIB = 12,
725   };
726
727 /* We use the objfile->obj_private pointer for two things:
728
729  * 1.  An unwind table;
730  *
731  * 2.  A pointer to any associated shared library object.
732  *
733  * #defines are used to help refer to these objects.
734  */
735
736 /* Info about the unwind table associated with an object file.
737
738  * This is hung off of the "objfile->obj_private" pointer, and
739  * is allocated in the objfile's psymbol obstack.  This allows
740  * us to have unique unwind info for each executable and shared
741  * library that we are debugging.
742  */
743 struct obj_unwind_info
744   {
745     struct unwind_table_entry *table;   /* Pointer to unwind info */
746     struct unwind_table_entry *cache;   /* Pointer to last entry we found */
747     int last;                   /* Index of last entry */
748   };
749
750 typedef struct obj_private_struct
751   {
752     struct obj_unwind_info *unwind_info;        /* a pointer */
753     struct so_list *so_info;    /* a pointer  */
754     CORE_ADDR dp;
755   }
756 obj_private_data_t;
757
758 #if 0
759 extern void target_write_pc (CORE_ADDR, int);
760 extern CORE_ADDR target_read_pc (int);
761 extern CORE_ADDR skip_trampoline_code (CORE_ADDR, char *);
762 #endif
763
764 #if !GDB_MULTI_ARCH
765 #define TARGET_READ_PC(pid) hppa_target_read_pc (pid)
766 extern CORE_ADDR hppa_target_read_pc (ptid_t);
767 #endif
768
769 #if !GDB_MULTI_ARCH
770 #define TARGET_WRITE_PC(v,pid) hppa_target_write_pc (v,pid)
771 extern void hppa_target_write_pc (CORE_ADDR, ptid_t);
772 #endif
773
774 #if !GDB_MULTI_ARCH
775 #define TARGET_READ_FP() hppa_target_read_fp ()
776 extern CORE_ADDR hppa_target_read_fp (void);
777 #endif
778
779 /* For a number of horrible reasons we may have to adjust the location
780    of variables on the stack.  Ugh.  */
781 #define HPREAD_ADJUST_STACK_ADDRESS(ADDR) hpread_adjust_stack_address(ADDR)
782 extern int hpread_adjust_stack_address (CORE_ADDR);
783
784 /* Here's how to step off a permanent breakpoint.  */
785 #define SKIP_PERMANENT_BREAKPOINT (hppa_skip_permanent_breakpoint)
786 extern void hppa_skip_permanent_breakpoint (void);
787
788 /* On HP-UX, certain system routines (millicode) have names beginning
789    with $ or $$, e.g. $$dyncall, which handles inter-space procedure
790    calls on PA-RISC.  Tell the expression parser to check for those
791    when parsing tokens that begin with "$".  */
792 #define SYMBOLS_CAN_START_WITH_DOLLAR (1)