f6f737dbd4fa68dd80f8d330928e27248d7a604b
[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 #define REGISTER_U_ADDR(addr, blockend, regno) \
143         (addr) = i386_register_u_addr ((blockend),(regno));
144
145 /* Total amount of space needed to store our copies of the machine's
146    register state, the array `registers'.  */
147 #define REGISTER_BYTES (NUM_REGS * 4)
148
149 /* Index within `registers' of the first byte of the space for
150    register N.  */
151
152 #define REGISTER_BYTE(N) ((N)*4)
153
154 /* Number of bytes of storage in the actual machine representation
155    for register N.  */
156
157 #define REGISTER_RAW_SIZE(N) (4)
158
159 /* Number of bytes of storage in the program's representation
160    for register N. */
161
162 #define REGISTER_VIRTUAL_SIZE(N) (4)
163
164 /* Largest value REGISTER_RAW_SIZE can have.  */
165
166 #define MAX_REGISTER_RAW_SIZE 4
167
168 /* Largest value REGISTER_VIRTUAL_SIZE can have.  */
169
170 #define MAX_REGISTER_VIRTUAL_SIZE 4
171
172 /* Nonzero if register N requires conversion
173    from raw format to virtual format.  */
174
175 #define REGISTER_CONVERTIBLE(N) (0)
176
177 /* Convert data from raw format for register REGNUM
178    to virtual format for register REGNUM.  */
179
180 #define REGISTER_CONVERT_TO_VIRTUAL(REGNUM,FROM,TO) {bcopy ((FROM), (TO), 4);}
181
182 /* Convert data from virtual format for register REGNUM
183    to raw format for register REGNUM.  */
184
185 #define REGISTER_CONVERT_TO_RAW(REGNUM,FROM,TO) {bcopy ((FROM), (TO), 4);}
186
187 /* Return the GDB type object for the "standard" data type
188    of data in register N.  */
189 /* Perhaps si and di should go here, but potentially they could be
190    used for things other than address.  */
191 #define REGISTER_VIRTUAL_TYPE(N) \
192   ((N) == PC_REGNUM || (N) == FP_REGNUM || (N) == SP_REGNUM ?         \
193    lookup_pointer_type (builtin_type_void) : builtin_type_int)
194
195 /* Store the address of the place in which to copy the structure the
196    subroutine will return.  This is called from call_function. */
197
198 #define STORE_STRUCT_RETURN(ADDR, SP) \
199   { (SP) -= sizeof (ADDR);              \
200     write_memory ((SP), &(ADDR), sizeof (ADDR)); }
201
202 /* Extract from an array REGBUF containing the (raw) register state
203    a function return value of type TYPE, and copy that, in virtual format,
204    into VALBUF.  */
205
206 #define EXTRACT_RETURN_VALUE(TYPE,REGBUF,VALBUF) \
207   bcopy (REGBUF, VALBUF, TYPE_LENGTH (TYPE))
208
209 /* Write into appropriate registers a function return value
210    of type TYPE, given in virtual format.  */
211
212 #define STORE_RETURN_VALUE(TYPE,VALBUF) \
213   write_register_bytes (0, VALBUF, TYPE_LENGTH (TYPE))
214
215 /* Extract from an array REGBUF containing the (raw) register state
216    the address in which a function should return its structure value,
217    as a CORE_ADDR (or an expression that can be used as one).  */
218
219 #define EXTRACT_STRUCT_VALUE_ADDRESS(REGBUF) (*(int *)(REGBUF))
220
221 \f
222 /* Describe the pointer in each stack frame to the previous stack frame
223    (its caller).  */
224
225 /* FRAME_CHAIN takes a frame's nominal address
226    and produces the frame's chain-pointer.
227
228    FRAME_CHAIN_COMBINE takes the chain pointer and the frame's nominal address
229    and produces the nominal address of the caller frame.
230
231    However, if FRAME_CHAIN_VALID returns zero,
232    it means the given frame is the outermost one and has no caller.
233    In that case, FRAME_CHAIN_COMBINE is not used.  */
234
235 #define FRAME_CHAIN(thisframe) \
236   (outside_startup_file ((thisframe)->pc) ? \
237    read_memory_integer ((thisframe)->frame, 4) :\
238    0)
239
240 #define FRAME_CHAIN_VALID(chain, thisframe) \
241   (chain != 0 && (outside_startup_file (FRAME_SAVED_PC (thisframe))))
242
243 #define FRAME_CHAIN_COMBINE(chain, thisframe) (chain)
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, FRAMELESS) \
251   (FRAMELESS) = frameless_look_for_prologue(FI)
252
253 #define FRAME_SAVED_PC(FRAME) (read_memory_integer ((FRAME)->frame + 4, 4))
254
255 #define FRAME_ARGS_ADDRESS(fi) ((fi)->frame)
256
257 #define FRAME_LOCALS_ADDRESS(fi) ((fi)->frame)
258
259 /* Return number of args passed to a frame.
260    Can return -1, meaning no way to tell.  */
261
262 #define FRAME_NUM_ARGS(numargs, fi) (numargs) = i386_frame_num_args(fi)
263
264 /* Return number of bytes at start of arglist that are not really args.  */
265
266 #define FRAME_ARGS_SKIP 8
267
268 /* Put here the code to store, into a struct frame_saved_regs,
269    the addresses of the saved registers of frame described by FRAME_INFO.
270    This includes special registers such as pc and fp saved in special
271    ways in the stack frame.  sp is even more special:
272    the address we return for it IS the sp for the next frame.  */
273
274 #define FRAME_FIND_SAVED_REGS(frame_info, frame_saved_regs) \
275 { i386_frame_find_saved_regs ((frame_info), &(frame_saved_regs)); }
276
277 \f
278 /* Things needed for making the inferior call functions.  */
279
280 /* Push an empty stack frame, to record the current PC, etc.  */
281
282 #define PUSH_DUMMY_FRAME { i386_push_dummy_frame (); }
283
284 /* Discard from the stack the innermost frame, restoring all registers.  */
285
286 #define POP_FRAME  { i386_pop_frame (); }
287
288 /* this is 
289  *   call 11223344 (32 bit relative)
290  *   int3
291  */
292
293 #define CALL_DUMMY { 0x223344e8, 0xcc11 }
294
295 #define CALL_DUMMY_LENGTH 8
296
297 #define CALL_DUMMY_START_OFFSET 0  /* Start execution at beginning of dummy */
298
299 /* Insert the specified number of args and function address
300    into a call sequence of the above form stored at DUMMYNAME.  */
301
302 #define FIX_CALL_DUMMY(dummyname, pc, fun, nargs, args, type, gcc_p)   \
303 { \
304         int from, to, delta, loc; \
305         loc = (int)(read_register (SP_REGNUM) - CALL_DUMMY_LENGTH); \
306         from = loc + 5; \
307         to = (int)(fun); \
308         delta = to - from; \
309         *((char *)(dummyname) + 1) = (delta & 0xff); \
310         *((char *)(dummyname) + 2) = ((delta >> 8) & 0xff); \
311         *((char *)(dummyname) + 3) = ((delta >> 16) & 0xff); \
312         *((char *)(dummyname) + 4) = ((delta >> 24) & 0xff); \
313 }