Intel 386 Mach host port.
[platform/upstream/binutils.git] / gdb / tm-i386v.h
1 /* Macro defintions for i386.
2    Copyright (C) 1986, 1987, 1989 Free Software Foundation, Inc.
3
4 This file is part of GDB.
5
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
10
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
19
20 /*
21  * Changes for 80386 by Pace Willisson (pace@prep.ai.mit.edu)
22  * July 1988
23  */
24
25 #define TARGET_BYTE_ORDER LITTLE_ENDIAN
26
27 /* define this if you don't have the extension to coff that allows
28  * file names to appear in the string table
29  * (aux.x_file.x_foff)
30  */
31 #define COFF_NO_LONG_FILE_NAMES
32
33 /* turn this on when rest of gdb is ready */
34 /* #define IEEE_FLOAT */
35
36 /* Define this if the C compiler puts an underscore at the front
37    of external names before giving them to the linker.  */
38
39 /* #define NAMES_HAVE_UNDERSCORE */
40
41 /* Specify debugger information format.  */
42
43 /* #define READ_DBX_FORMAT */
44 #define COFF_FORMAT
45
46 /* number of traps that happen between exec'ing the shell 
47  * to run an inferior, and when we finally get to 
48  * the inferior code.  This is 2 on most implementations.
49  */
50 #define START_INFERIOR_TRAPS_EXPECTED 4
51
52 /* Offset from address of function to start of its code.
53    Zero on most machines.  */
54
55 #define FUNCTION_START_OFFSET 0
56
57 /* Advance PC across any function entry prologue instructions
58    to reach some "real" code.  */
59
60 #define SKIP_PROLOGUE(frompc)   {(frompc) = i386_skip_prologue((frompc));}
61
62 /* Immediately after a function call, return the saved pc.
63    Can't always go through the frames for this because on some machines
64    the new frame is not set up until the new function executes
65    some instructions.  */
66
67 #define SAVED_PC_AFTER_CALL(frame) \
68   (read_memory_integer (read_register (SP_REGNUM), 4))
69
70 /* Address of end of stack space.  */
71
72 #define STACK_END_ADDR 0x80000000
73
74 /* Stack grows downward.  */
75
76 #define INNER_THAN <
77
78 /* Sequence of bytes for breakpoint instruction.  */
79
80 #define BREAKPOINT {0xcc}
81
82 /* Amount PC must be decremented by after a breakpoint.
83    This is often the number of bytes in BREAKPOINT
84    but not always.  */
85
86 #define DECR_PC_AFTER_BREAK 1
87
88 /* Nonzero if instruction at PC is a return instruction.  */
89
90 #define ABOUT_TO_RETURN(pc) (read_memory_integer (pc, 1) == 0xc3)
91
92 /* Return 1 if P points to an invalid floating point value.
93    LEN is the length in bytes -- not relevant on the 386.  */
94
95 #define INVALID_FLOAT(p, len) (0)
96
97 #if 0
98 /* code to execute to print interesting information about the
99    floating point processor (if any)
100    No need to define if there is nothing to do.
101    On the 386, unfortunately this code is host-dependent (and lives
102    in the i386-xdep.c file), so we can't
103    do this unless we *know* we aren't cross-debugging.  FIXME.
104  */
105 #define FLOAT_INFO { i386_float_info (); }
106 #endif 0
107
108 /* Say how long (ordinary) registers are.  */
109
110 #define REGISTER_TYPE long
111
112 /* Number of machine registers */
113
114 #define NUM_REGS 16
115
116 /* Initializer for an array of names of registers.
117    There should be NUM_REGS strings in this initializer.  */
118
119 /* the order of the first 8 registers must match the compiler's 
120  * numbering scheme (which is the same as the 386 scheme)
121  * also, this table must match regmap in i386-pinsn.c.
122  */
123 #define REGISTER_NAMES { "eax", "ecx", "edx", "ebx", \
124                          "esp", "ebp", "esi", "edi", \
125                          "eip", "ps", "cs", "ss", \
126                          "ds", "es", "fs", "gs", \
127                          }
128
129 /* Register numbers of various important registers.
130    Note that some of these values are "real" register numbers,
131    and correspond to the general registers of the machine,
132    and some are "phony" register numbers which are too large
133    to be actual register numbers as far as the user is concerned
134    but do serve to get the desired values when passed to read_register.  */
135
136 #define FP_REGNUM 5             /* Contains address of executing stack frame */
137 #define SP_REGNUM 4             /* Contains address of top of stack */
138
139 #define PC_REGNUM 8
140 #define PS_REGNUM 9
141
142 /* Total amount of space needed to store our copies of the machine's
143    register state, the array `registers'.  */
144 #define REGISTER_BYTES (NUM_REGS * 4)
145
146 /* Index within `registers' of the first byte of the space for
147    register N.  */
148
149 #define REGISTER_BYTE(N) ((N)*4)
150
151 /* Number of bytes of storage in the actual machine representation
152    for register N.  */
153
154 #define REGISTER_RAW_SIZE(N) (4)
155
156 /* Number of bytes of storage in the program's representation
157    for register N. */
158
159 #define REGISTER_VIRTUAL_SIZE(N) (4)
160
161 /* Largest value REGISTER_RAW_SIZE can have.  */
162
163 #define MAX_REGISTER_RAW_SIZE 4
164
165 /* Largest value REGISTER_VIRTUAL_SIZE can have.  */
166
167 #define MAX_REGISTER_VIRTUAL_SIZE 4
168
169 /* Nonzero if register N requires conversion
170    from raw format to virtual format.  */
171
172 #define REGISTER_CONVERTIBLE(N) (0)
173
174 /* Convert data from raw format for register REGNUM
175    to virtual format for register REGNUM.  */
176
177 #define REGISTER_CONVERT_TO_VIRTUAL(REGNUM,FROM,TO) {bcopy ((FROM), (TO), 4);}
178
179 /* Convert data from virtual format for register REGNUM
180    to raw format for register REGNUM.  */
181
182 #define REGISTER_CONVERT_TO_RAW(REGNUM,FROM,TO) {bcopy ((FROM), (TO), 4);}
183
184 /* Return the GDB type object for the "standard" data type
185    of data in register N.  */
186 /* Perhaps si and di should go here, but potentially they could be
187    used for things other than address.  */
188 #define REGISTER_VIRTUAL_TYPE(N) \
189   ((N) == PC_REGNUM || (N) == FP_REGNUM || (N) == SP_REGNUM ?         \
190    lookup_pointer_type (builtin_type_void) : builtin_type_int)
191
192 /* Store the address of the place in which to copy the structure the
193    subroutine will return.  This is called from call_function. */
194
195 #define STORE_STRUCT_RETURN(ADDR, SP) \
196   { (SP) -= sizeof (ADDR);              \
197     write_memory ((SP), &(ADDR), sizeof (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.  */
202
203 #define EXTRACT_RETURN_VALUE(TYPE,REGBUF,VALBUF) \
204   bcopy (REGBUF, VALBUF, TYPE_LENGTH (TYPE))
205
206 /* Write into appropriate registers a function return value
207    of type TYPE, given in virtual format.  */
208
209 #define STORE_RETURN_VALUE(TYPE,VALBUF) \
210   write_register_bytes (0, VALBUF, TYPE_LENGTH (TYPE))
211
212 /* Extract from an array REGBUF containing the (raw) register state
213    the address in which a function should return its structure value,
214    as a CORE_ADDR (or an expression that can be used as one).  */
215
216 #define EXTRACT_STRUCT_VALUE_ADDRESS(REGBUF) (*(int *)(REGBUF))
217
218 \f
219 /* Describe the pointer in each stack frame to the previous stack frame
220    (its caller).  */
221
222 /* FRAME_CHAIN takes a frame's nominal address
223    and produces the frame's chain-pointer.
224
225    FRAME_CHAIN_COMBINE takes the chain pointer and the frame's nominal address
226    and produces the nominal address of the caller frame.
227
228    However, if FRAME_CHAIN_VALID returns zero,
229    it means the given frame is the outermost one and has no caller.
230    In that case, FRAME_CHAIN_COMBINE is not used.  */
231
232 #define FRAME_CHAIN(thisframe) \
233   (outside_startup_file ((thisframe)->pc) ? \
234    read_memory_integer ((thisframe)->frame, 4) :\
235    0)
236
237 #define FRAME_CHAIN_VALID(chain, thisframe) \
238   (chain != 0 && (outside_startup_file (FRAME_SAVED_PC (thisframe))))
239
240 #define FRAME_CHAIN_COMBINE(chain, thisframe) (chain)
241
242 /* Define other aspects of the stack frame.  */
243
244 /* A macro that tells us whether the function invocation represented
245    by FI does not have a frame on the stack associated with it.  If it
246    does not, FRAMELESS is set to 1, else 0.  */
247 #define FRAMELESS_FUNCTION_INVOCATION(FI, FRAMELESS) \
248   (FRAMELESS) = frameless_look_for_prologue(FI)
249
250 #define FRAME_SAVED_PC(FRAME) (read_memory_integer ((FRAME)->frame + 4, 4))
251
252 #define FRAME_ARGS_ADDRESS(fi) ((fi)->frame)
253
254 #define FRAME_LOCALS_ADDRESS(fi) ((fi)->frame)
255
256 /* Return number of args passed to a frame.
257    Can return -1, meaning no way to tell.  */
258
259 #define FRAME_NUM_ARGS(numargs, fi) (numargs) = i386_frame_num_args(fi)
260
261 /* Return number of bytes at start of arglist that are not really args.  */
262
263 #define FRAME_ARGS_SKIP 8
264
265 /* Put here the code to store, into a struct frame_saved_regs,
266    the addresses of the saved registers of frame described by FRAME_INFO.
267    This includes special registers such as pc and fp saved in special
268    ways in the stack frame.  sp is even more special:
269    the address we return for it IS the sp for the next frame.  */
270
271 #define FRAME_FIND_SAVED_REGS(frame_info, frame_saved_regs) \
272 { i386_frame_find_saved_regs ((frame_info), &(frame_saved_regs)); }
273
274 \f
275 /* Things needed for making the inferior call functions.  */
276
277 /* Push an empty stack frame, to record the current PC, etc.  */
278
279 #define PUSH_DUMMY_FRAME { i386_push_dummy_frame (); }
280
281 /* Discard from the stack the innermost frame, restoring all registers.  */
282
283 #define POP_FRAME  { i386_pop_frame (); }
284
285 /* this is 
286  *   call 11223344 (32 bit relative)
287  *   int3
288  */
289
290 #define CALL_DUMMY { 0x223344e8, 0xcc11 }
291
292 #define CALL_DUMMY_LENGTH 8
293
294 #define CALL_DUMMY_START_OFFSET 0  /* Start execution at beginning of dummy */
295
296 /* Insert the specified number of args and function address
297    into a call sequence of the above form stored at DUMMYNAME.  */
298
299 #define FIX_CALL_DUMMY(dummyname, pc, fun, nargs, args, type, gcc_p)   \
300 { \
301         int from, to, delta, loc; \
302         loc = (int)(read_register (SP_REGNUM) - CALL_DUMMY_LENGTH); \
303         from = loc + 5; \
304         to = (int)(fun); \
305         delta = to - from; \
306         *((char *)(dummyname) + 1) = (delta & 0xff); \
307         *((char *)(dummyname) + 2) = ((delta >> 8) & 0xff); \
308         *((char *)(dummyname) + 3) = ((delta >> 16) & 0xff); \
309         *((char *)(dummyname) + 4) = ((delta >> 24) & 0xff); \
310 }