+ * gdbarch.sh (DEPRECATED_EXTRACT_RETURN_VALUE): Rename
[deliverable/binutils-gdb.git] / gdb / config / m68k / tm-m68k.h
1 /* Parameters for execution on a 68000 series machine.
2 Copyright 1986, 1987, 1989, 1990, 1992, 1993, 1994, 1995, 1996, 1998,
3 1999, 2000 Free Software Foundation, Inc.
4
5 This file is part of GDB.
6
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
11
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
21
22 #include "regcache.h"
23
24 /* Generic 68000 stuff, to be included by other tm-*.h files. */
25
26 #define TARGET_LONG_DOUBLE_FORMAT &floatformat_m68881_ext
27
28 #define TARGET_LONG_DOUBLE_BIT 96
29
30 /* Offset from address of function to start of its code.
31 Zero on most machines. */
32
33 #define FUNCTION_START_OFFSET 0
34
35 /* Advance PC across any function entry prologue instructions
36 to reach some "real" code. */
37
38 #if !defined(SKIP_PROLOGUE)
39 #define SKIP_PROLOGUE(ip) (m68k_skip_prologue (ip))
40 #endif
41 extern CORE_ADDR m68k_skip_prologue (CORE_ADDR ip);
42
43 /* Immediately after a function call, return the saved pc.
44 Can't always go through the frames for this because on some machines
45 the new frame is not set up until the new function executes
46 some instructions. */
47
48 struct frame_info;
49 struct frame_saved_regs;
50
51 extern CORE_ADDR m68k_saved_pc_after_call (struct frame_info *);
52 extern void m68k_find_saved_regs (struct frame_info *,
53 struct frame_saved_regs *);
54
55 #define SAVED_PC_AFTER_CALL(frame) \
56 m68k_saved_pc_after_call(frame)
57
58 /* Stack grows downward. */
59
60 #define INNER_THAN(lhs,rhs) ((lhs) < (rhs))
61
62 /* Stack must be kept short aligned when doing function calls. */
63
64 #define STACK_ALIGN(ADDR) (((ADDR) + 1) & ~1)
65
66 /* Sequence of bytes for breakpoint instruction.
67 This is a TRAP instruction. The last 4 bits (0xf below) is the
68 vector. Systems which don't use 0xf should define BPT_VECTOR
69 themselves before including this file. */
70
71 #if !defined (BPT_VECTOR)
72 #define BPT_VECTOR 0xf
73 #endif
74
75 #if !defined (BREAKPOINT)
76 #define BREAKPOINT {0x4e, (0x40 | BPT_VECTOR)}
77 #endif
78
79 /* We default to vector 1 for the "remote" target, but allow targets
80 to override. */
81 #if !defined (REMOTE_BPT_VECTOR)
82 #define REMOTE_BPT_VECTOR 1
83 #endif
84
85 #if !defined (REMOTE_BREAKPOINT)
86 #define REMOTE_BREAKPOINT {0x4e, (0x40 | REMOTE_BPT_VECTOR)}
87 #endif
88
89 /* If your kernel resets the pc after the trap happens you may need to
90 define this before including this file. */
91
92 #if !defined (DECR_PC_AFTER_BREAK)
93 #define DECR_PC_AFTER_BREAK 2
94 #endif
95
96 /* Say how long (ordinary) registers are. This is a piece of bogosity
97 used in push_word and a few other places; REGISTER_RAW_SIZE is the
98 real way to know how big a register is. */
99
100 #define REGISTER_SIZE 4
101
102 #define REGISTER_BYTES_FP (16*4 + 8 + 8*12 + 3*4)
103 #define REGISTER_BYTES_NOFP (16*4 + 8)
104
105 #ifndef NUM_REGS
106 #define NUM_REGS 29
107 #endif
108
109 #define NUM_FREGS (NUM_REGS-24)
110
111 #ifndef REGISTER_BYTES_OK
112 #define REGISTER_BYTES_OK(b) \
113 ((b) == REGISTER_BYTES_FP \
114 || (b) == REGISTER_BYTES_NOFP)
115 #endif
116
117 #ifndef REGISTER_BYTES
118 #define REGISTER_BYTES (16*4 + 8 + 8*12 + 3*4)
119 #endif
120
121 /* Index within `registers' of the first byte of the space for
122 register N. */
123
124 #define REGISTER_BYTE(N) \
125 ((N) >= FPC_REGNUM ? (((N) - FPC_REGNUM) * 4) + 168 \
126 : (N) >= FP0_REGNUM ? (((N) - FP0_REGNUM) * 12) + 72 \
127 : (N) * 4)
128
129 /* Number of bytes of storage in the actual machine representation
130 for register N. On the 68000, all regs are 4 bytes
131 except the floating point regs which are 12 bytes. */
132 /* Note that the unsigned cast here forces the result of the
133 subtraction to very high positive values if N < FP0_REGNUM */
134
135 #define REGISTER_RAW_SIZE(N) (((unsigned)(N) - FP0_REGNUM) < 8 ? 12 : 4)
136
137 /* Number of bytes of storage in the program's representation
138 for register N. On the 68000, all regs are 4 bytes
139 except the floating point regs which are 12-byte long doubles. */
140
141 #define REGISTER_VIRTUAL_SIZE(N) (((unsigned)(N) - FP0_REGNUM) < 8 ? 12 : 4)
142
143 /* Largest value REGISTER_RAW_SIZE can have. */
144
145 #define MAX_REGISTER_RAW_SIZE 12
146
147 /* Largest value REGISTER_VIRTUAL_SIZE can have. */
148
149 #define MAX_REGISTER_VIRTUAL_SIZE 12
150
151 /* Return the GDB type object for the "standard" data type of data
152 in register N. This should be int for D0-D7, long double for FP0-FP7,
153 and void pointer for all others (A0-A7, PC, SR, FPCONTROL etc).
154 Note, for registers which contain addresses return pointer to void,
155 not pointer to char, because we don't want to attempt to print
156 the string after printing the address. */
157
158 #define REGISTER_VIRTUAL_TYPE(N) \
159 ((unsigned) (N) >= FPC_REGNUM ? lookup_pointer_type (builtin_type_void) : \
160 (unsigned) (N) >= FP0_REGNUM ? builtin_type_long_double : \
161 (unsigned) (N) >= A0_REGNUM ? lookup_pointer_type (builtin_type_void) : \
162 builtin_type_int)
163
164 /* Initializer for an array of names of registers.
165 Entries beyond the first NUM_REGS are ignored. */
166
167 #define REGISTER_NAMES \
168 {"d0", "d1", "d2", "d3", "d4", "d5", "d6", "d7", \
169 "a0", "a1", "a2", "a3", "a4", "a5", "fp", "sp", \
170 "ps", "pc", \
171 "fp0", "fp1", "fp2", "fp3", "fp4", "fp5", "fp6", "fp7", \
172 "fpcontrol", "fpstatus", "fpiaddr", "fpcode", "fpflags" }
173
174 /* Register numbers of various important registers.
175 Note that some of these values are "real" register numbers,
176 and correspond to the general registers of the machine,
177 and some are "phony" register numbers which are too large
178 to be actual register numbers as far as the user is concerned
179 but do serve to get the desired values when passed to read_register. */
180
181 #define D0_REGNUM 0
182 #define A0_REGNUM 8
183 #define A1_REGNUM 9
184 #define FP_REGNUM 14 /* Contains address of executing stack frame */
185 #define SP_REGNUM 15 /* Contains address of top of stack */
186 #define PS_REGNUM 16 /* Contains processor status */
187 #define PC_REGNUM 17 /* Contains program counter */
188 #define FP0_REGNUM 18 /* Floating point register 0 */
189 #define FPC_REGNUM 26 /* 68881 control register */
190 #define FPS_REGNUM 27 /* 68881 status register */
191 #define FPI_REGNUM 28 /* 68881 iaddr register */
192
193 /* Store the address of the place in which to copy the structure the
194 subroutine will return. This is called from call_function. */
195
196 #define STORE_STRUCT_RETURN(ADDR, SP) \
197 { write_register (A1_REGNUM, (ADDR)); }
198
199 /* Extract from an array REGBUF containing the (raw) register state
200 a function return value of type TYPE, and copy that, in virtual format,
201 into VALBUF. This is assuming that floating point values are returned
202 as doubles in d0/d1. */
203
204 #if !defined (DEPRECATED_EXTRACT_RETURN_VALUE)
205 #define DEPRECATED_EXTRACT_RETURN_VALUE(TYPE,REGBUF,VALBUF) \
206 memcpy ((VALBUF), \
207 (char *)(REGBUF) + \
208 (TYPE_LENGTH(TYPE) >= 4 ? 0 : 4 - TYPE_LENGTH(TYPE)), \
209 TYPE_LENGTH(TYPE))
210 #endif
211
212 /* Write into appropriate registers a function return value
213 of type TYPE, given in virtual format. Assumes floats are passed
214 in d0/d1. */
215
216 #if !defined (STORE_RETURN_VALUE)
217 #define STORE_RETURN_VALUE(TYPE,VALBUF) \
218 write_register_bytes (0, VALBUF, TYPE_LENGTH (TYPE))
219 #endif
220
221 /* Extract from an array REGBUF containing the (raw) register state
222 the address in which a function should return its structure value,
223 as a CORE_ADDR (or an expression that can be used as one). */
224
225 #define DEPRECATED_EXTRACT_STRUCT_VALUE_ADDRESS(REGBUF) (*(CORE_ADDR *)(REGBUF))
226 \f
227 /* Describe the pointer in each stack frame to the previous stack frame
228 (its caller). */
229
230 /* FRAME_CHAIN takes a frame's nominal address and produces the frame's
231 chain-pointer.
232 In the case of the 68000, the frame's nominal address
233 is the address of a 4-byte word containing the calling frame's address. */
234
235 /* If we are chaining from sigtramp, then manufacture a sigtramp frame
236 (which isn't really on the stack. I'm not sure this is right for anything
237 but BSD4.3 on an hp300. */
238 #define FRAME_CHAIN(thisframe) \
239 (thisframe->signal_handler_caller \
240 ? thisframe->frame \
241 : (!inside_entry_file ((thisframe)->pc) \
242 ? read_memory_integer ((thisframe)->frame, 4) \
243 : 0))
244
245 /* Define other aspects of the stack frame. */
246
247 /* A macro that tells us whether the function invocation represented
248 by FI does not have a frame on the stack associated with it. If it
249 does not, FRAMELESS is set to 1, else 0. */
250 #define FRAMELESS_FUNCTION_INVOCATION(FI) \
251 (((FI)->signal_handler_caller) ? 0 : frameless_look_for_prologue(FI))
252
253 /* This was determined by experimentation on hp300 BSD 4.3. Perhaps
254 it corresponds to some offset in /usr/include/sys/user.h or
255 something like that. Using some system include file would
256 have the advantage of probably being more robust in the face
257 of OS upgrades, but the disadvantage of being wrong for
258 cross-debugging. */
259
260 #define SIG_PC_FP_OFFSET 530
261
262 #define FRAME_SAVED_PC(FRAME) \
263 (((FRAME)->signal_handler_caller \
264 ? ((FRAME)->next \
265 ? read_memory_integer ((FRAME)->next->frame + SIG_PC_FP_OFFSET, 4) \
266 : read_memory_integer (read_register (SP_REGNUM) \
267 + SIG_PC_FP_OFFSET - 8, 4) \
268 ) \
269 : read_memory_integer ((FRAME)->frame + 4, 4)) \
270 )
271
272 #define FRAME_ARGS_ADDRESS(fi) ((fi)->frame)
273
274 #define FRAME_LOCALS_ADDRESS(fi) ((fi)->frame)
275
276 /* Set VAL to the number of args passed to frame described by FI.
277 Can set VAL to -1, meaning no way to tell. */
278
279 /* We can't tell how many args there are
280 now that the C compiler delays popping them. */
281 #if !defined (FRAME_NUM_ARGS)
282 #define FRAME_NUM_ARGS(fi) (-1)
283 #endif
284
285 /* Return number of bytes at start of arglist that are not really args. */
286
287 #define FRAME_ARGS_SKIP 8
288
289 /* Put here the code to store, into a struct frame_saved_regs,
290 the addresses of the saved registers of frame described by FRAME_INFO.
291 This includes special registers such as pc and fp saved in special
292 ways in the stack frame. sp is even more special:
293 the address we return for it IS the sp for the next frame. */
294
295 #if !defined (FRAME_FIND_SAVED_REGS)
296 #define FRAME_FIND_SAVED_REGS(fi,fsr) m68k_find_saved_regs ((fi), &(fsr))
297 #endif /* no FIND_FRAME_SAVED_REGS. */
298 \f
299
300 /* Things needed for making the inferior call functions. */
301
302 /* The CALL_DUMMY macro is the sequence of instructions, as disassembled
303 by gdb itself:
304
305 These instructions exist only so that m68k_find_saved_regs can parse
306 them as a "prologue"; they are never executed.
307
308 fmovemx fp0-fp7,sp@- 0xf227 0xe0ff
309 moveml d0-a5,sp@- 0x48e7 0xfffc
310 clrw sp@- 0x4267
311 movew ccr,sp@- 0x42e7
312
313 The arguments are pushed at this point by GDB; no code is needed in
314 the dummy for this. The CALL_DUMMY_START_OFFSET gives the position
315 of the following jsr instruction. That is where we start
316 executing.
317
318 jsr @#0x32323232 0x4eb9 0x3232 0x3232
319 addal #0x69696969,sp 0xdffc 0x6969 0x6969
320 trap #<your BPT_VECTOR number here> 0x4e4?
321 nop 0x4e71
322
323 Note this is CALL_DUMMY_LENGTH bytes (28 for the above example).
324
325 The dummy frame always saves the floating-point registers, whether they
326 actually exist on this target or not. */
327
328 /* FIXME: Wrong to hardwire this as BPT_VECTOR when sometimes it
329 should be REMOTE_BPT_VECTOR. Best way to fix it would be to define
330 CALL_DUMMY_BREAKPOINT_OFFSET. */
331
332 #define CALL_DUMMY {0xf227e0ff, 0x48e7fffc, 0x426742e7, 0x4eb93232, 0x3232dffc, 0x69696969, (0x4e404e71 | (BPT_VECTOR << 16))}
333 #define CALL_DUMMY_LENGTH 28 /* Size of CALL_DUMMY */
334 #define CALL_DUMMY_START_OFFSET 12 /* Offset to jsr instruction */
335 #define CALL_DUMMY_BREAKPOINT_OFFSET (CALL_DUMMY_START_OFFSET + 12)
336
337 /* Insert the specified number of args and function address
338 into a call sequence of the above form stored at DUMMYNAME.
339 We use the BFD routines to store a big-endian value of known size. */
340
341 #define FIX_CALL_DUMMY(dummyname, pc, fun, nargs, args, type, gcc_p) \
342 { bfd_putb32 (fun, (unsigned char *) dummyname + CALL_DUMMY_START_OFFSET + 2); \
343 bfd_putb32 (nargs*4, (unsigned char *) dummyname + CALL_DUMMY_START_OFFSET + 8); }
344
345 /* Push an empty stack frame, to record the current PC, etc. */
346
347 #define PUSH_DUMMY_FRAME { m68k_push_dummy_frame (); }
348
349 extern void m68k_push_dummy_frame (void);
350
351 extern void m68k_pop_frame (void);
352
353 /* Discard from the stack the innermost frame, restoring all registers. */
354
355 #define POP_FRAME { m68k_pop_frame (); }
356
357 /* Offset from SP to first arg on stack at first instruction of a function */
358
359 #define SP_ARG0 (1 * 4)
360
361 #define TARGET_M68K
362
363 /* Figure out where the longjmp will land. Slurp the args out of the stack.
364 We expect the first arg to be a pointer to the jmp_buf structure from which
365 we extract the pc (JB_PC) that we will land at. The pc is copied into ADDR.
366 This routine returns true on success */
367
368 extern int m68k_get_longjmp_target (CORE_ADDR *);
This page took 0.037578 seconds and 5 git commands to generate.