gdb/config/i386/tm-i386.h

   1 /* Macro definitions for GDB on an Intel i[345]86.
   2    Copyright (C) 1995, 1996, 2000 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., 59 Temple Place - Suite 330,
  19    Boston, MA 02111-1307, USA.  */
  20
  21 #ifndef TM_I386_H
  22 #define TM_I386_H 1
  23
  24 /* Forward declarations for prototypes.  */
  25 struct frame_info;
  26 struct frame_saved_regs;
  27 struct value;
  28 struct type;
  29
  30 #define TARGET_BYTE_ORDER LITTLE_ENDIAN
  31
  32 /* The format used for `long double' on almost all i386 targets is the
  33    i387 extended floating-point format.  In fact, of all targets in the
  34    GCC 2.95 tree, only OSF/1 does it different, and insists on having
  35    a `long double' that's not `long' at all.  */
  36
  37 #define TARGET_LONG_DOUBLE_FORMAT &floatformat_i387_ext
  38
  39 /* Although the i386 extended floating-point has only 80 significant
  40    bits, a `long double' actually takes up 96, probably to enforce
  41    alignment.  */
  42
  43 #define TARGET_LONG_DOUBLE_BIT 96
  44
  45 /* Used for example in valprint.c:print_floating() to enable checking
  46    for NaN's */
  47
  48 #define IEEE_FLOAT (1)
  49
  50 /* Number of traps that happen between exec'ing the shell to run an
  51    inferior, and when we finally get to the inferior code.  This is 2
  52    on most implementations. */
  53
  54 #define START_INFERIOR_TRAPS_EXPECTED 2
  55
  56 /* Offset from address of function to start of its code.
  57    Zero on most machines.  */
  58
  59 #define FUNCTION_START_OFFSET 0
  60
  61 /* Advance PC across any function entry prologue instructions to reach some
  62    "real" code.  */
  63
  64 #define SKIP_PROLOGUE(frompc)   (i386_skip_prologue (frompc))
  65
  66 extern int i386_skip_prologue (int);
  67
  68 /* Immediately after a function call, return the saved pc.  Can't always go
  69    through the frames for this because on some machines the new frame is not
  70    set up until the new function executes some instructions.  */
  71
  72 #define SAVED_PC_AFTER_CALL(frame) (read_memory_integer (read_register (SP_REGNUM), 4))
  73
  74 /* Stack grows downward.  */
  75
  76 #define INNER_THAN(lhs,rhs) ((lhs) < (rhs))
  77
  78 /* Sequence of bytes for breakpoint instruction.  */
  79
  80 #define BREAKPOINT {0xcc}
  81
  82 /* Amount PC must be decremented by after a breakpoint.  This is often the
  83    number of bytes in BREAKPOINT but not always. */
  84
  85 #define DECR_PC_AFTER_BREAK 1
  86
  87 /* Say how long (ordinary) registers are.  This is a piece of bogosity
  88    used in push_word and a few other places; REGISTER_RAW_SIZE is the
  89    real way to know how big a register is.  */
  90
  91 #define REGISTER_SIZE 4
  92
  93 /* This register file is parameterized by two macros:
  94    HAVE_I387_REGS --- register file should include i387 registers
  95    HAVE_SSE_REGS  --- register file should include SSE registers
  96    If HAVE_SSE_REGS is #defined, then HAVE_I387_REGS must also be #defined.
  97
  98    However, GDB code should not test those macros with #ifdef, since
  99    that makes code which is annoying to multi-arch.  Instead, GDB code
 100    should check the values of NUM_GREGS, NUM_FREGS, and NUM_SSE_REGS,
 101    which will eventually get mapped onto architecture vector entries.
 102
 103    It's okay to use the macros in tm-*.h files, though, since those
 104    files will get completely replaced when we multi-arch anyway.  */
 105
 106 /* Number of general registers, present on every 32-bit x86 variant.  */
 107 #define NUM_GREGS (16)
 108
 109 /* Number of floating-point unit registers.  */
 110 #ifdef HAVE_I387_REGS
 111 #define NUM_FREGS (16)
 112 #else
 113 #define NUM_FREGS (0)
 114 #endif
 115
 116 /* Number of SSE registers.  */
 117 #ifdef HAVE_SSE_REGS
 118 #define NUM_SSE_REGS (9)
 119 #else
 120 #define NUM_SSE_REGS (0)
 121 #endif
 122
 123 #define NUM_REGS (NUM_GREGS + NUM_FREGS + NUM_SSE_REGS)
 124
 125 /* Largest number of registers we could have in any configuration.  */
 126 #define MAX_NUM_REGS (16 + 16 + 9)
 127
 128 /* Initializer for an array of names of registers.  There should be at least
 129    NUM_REGS strings in this initializer.  Any excess ones are simply ignored.
 130    The order of the first 8 registers must match the compiler's numbering
 131    scheme (which is the same as the 386 scheme) and also regmap in the various
 132    *-nat.c files. */
 133
 134 #define REGISTER_NAMES { "eax",   "ecx",    "edx",   "ebx",     \
 135                          "esp",   "ebp",    "esi",   "edi",     \
 136                          "eip",   "eflags", "cs",    "ss",      \
 137                          "ds",    "es",     "fs",    "gs",      \
 138                          "st0",   "st1",    "st2",   "st3",     \
 139                          "st4",   "st5",    "st6",   "st7",     \
 140                          "fctrl", "fstat",  "ftag",  "fiseg",   \
 141                          "fioff", "foseg",  "fooff", "fop",     \
 142                          "xmm0",  "xmm1",   "xmm2",  "xmm3",    \
 143                          "xmm4",  "xmm5",   "xmm6",  "xmm7",    \
 144                          "mxcsr"                                \
 145                        }
 146
 147 /* Register numbers of various important registers.
 148    Note that some of these values are "real" register numbers,
 149    and correspond to the general registers of the machine,
 150    and some are "phony" register numbers which are too large
 151    to be actual register numbers as far as the user is concerned
 152    but do serve to get the desired values when passed to read_register.  */
 153
 154 #define FP_REGNUM 5             /* (ebp) Contains address of executing stack
 155                                    frame */
 156 #define SP_REGNUM 4             /* (usp) Contains address of top of stack */
 157 #define PC_REGNUM 8             /* (eip) Contains program counter */
 158 #define PS_REGNUM 9             /* (ps)  Contains processor status */
 159
 160 /* These registers are present only if HAVE_I387_REGS is #defined.
 161    We promise that FP0 .. FP7 will always be consecutive register numbers.  */
 162 #define FP0_REGNUM   16         /* first FPU floating-point register */
 163 #define FP7_REGNUM   23         /* last  FPU floating-point register */
 164
 165 /* All of these control registers (except for FCOFF and FDOFF) are
 166    sixteen bits long (at most) in the FPU, but are zero-extended to
 167    thirty-two bits in GDB's register file.  This makes it easier to
 168    compute the size of the control register file, and somewhat easier
 169    to convert to and from the FSAVE instruction's 32-bit format.  */
 170 #define FIRST_FPU_CTRL_REGNUM 24
 171 #define FCTRL_REGNUM 24         /* FPU control word */
 172 #define FPC_REGNUM   24         /* old name for FCTRL_REGNUM */
 173 #define FSTAT_REGNUM 25         /* FPU status word */
 174 #define FTAG_REGNUM  26         /* FPU register tag word */
 175 #define FCS_REGNUM   27         /* FPU instruction's code segment selector
 176                                    16 bits, called "FPU Instruction Pointer
 177                                    Selector" in the x86 manuals  */
 178 #define FCOFF_REGNUM 28         /* FPU instruction's offset within segment
 179                                    ("Fpu Code OFFset") */
 180 #define FDS_REGNUM   29         /* FPU operand's data segment */
 181 #define FDOFF_REGNUM 30         /* FPU operand's offset within segment */
 182 #define FOP_REGNUM   31         /* FPU opcode, bottom eleven bits */
 183 #define LAST_FPU_CTRL_REGNUM 31
 184
 185 /* These registers are present only if HAVE_SSE_REGS is #defined.
 186    We promise that XMM0 .. XMM7 will always have consecutive reg numbers. */
 187 #define XMM0_REGNUM  32         /* first SSE data register */
 188 #define XMM7_REGNUM  39         /* last  SSE data register */
 189 #define MXCSR_REGNUM 40         /* Streaming SIMD Extension control/status */
 190
 191 #define IS_FP_REGNUM(n) (FP0_REGNUM <= (n) && (n) <= FP7_REGNUM)
 192 #define IS_SSE_REGNUM(n) (XMM0_REGNUM <= (n) && (n) <= XMM7_REGNUM)
 193
 194 #define FPU_REG_RAW_SIZE (10)
 195
 196 /* Sizes of individual register sets.  These cover the entire register
 197    file, so summing up the sizes of those portions actually present
 198    yields REGISTER_BYTES.  */
 199 #define SIZEOF_GREGS (NUM_GREGS * 4)
 200 #define SIZEOF_FPU_REGS (8 * FPU_REG_RAW_SIZE)
 201 #define SIZEOF_FPU_CTRL_REGS \
 202   ((LAST_FPU_CTRL_REGNUM - FIRST_FPU_CTRL_REGNUM + 1) * 4)
 203 #define SIZEOF_SSE_REGS (8 * 16 + 4)
 204
 205
 206 /* Total amount of space needed to store our copies of the machine's register
 207    state, the array `registers'. */
 208 #ifdef HAVE_SSE_REGS
 209 #define REGISTER_BYTES \
 210   (SIZEOF_GREGS + SIZEOF_FPU_REGS + SIZEOF_FPU_CTRL_REGS + SIZEOF_SSE_REGS)
 211 #else
 212 #ifdef HAVE_I387_REGS
 213 #define REGISTER_BYTES (SIZEOF_GREGS + SIZEOF_FPU_REGS + SIZEOF_FPU_CTRL_REGS)
 214 #else
 215 #define REGISTER_BYTES (SIZEOF_GREGS)
 216 #endif
 217 #endif
 218
 219 /* Index within `registers' of the first byte of the space for register N. */
 220 #define REGISTER_BYTE(n) (i386_register_byte[(n)])
 221 extern int i386_register_byte[];
 222
 223 /* Number of bytes of storage in the actual machine representation for
 224    register N.  */
 225 #define REGISTER_RAW_SIZE(n) (i386_register_raw_size[(n)])
 226 extern int i386_register_raw_size[];
 227
 228 /* Largest value REGISTER_RAW_SIZE can have.  */
 229 #define MAX_REGISTER_RAW_SIZE 16
 230
 231 /* Number of bytes of storage in the program's representation
 232    for register N. */
 233 #define REGISTER_VIRTUAL_SIZE(n) (i386_register_virtual_size[(n)])
 234 extern int i386_register_virtual_size[];
 235
 236 /* Largest value REGISTER_VIRTUAL_SIZE can have.  */
 237 #define MAX_REGISTER_VIRTUAL_SIZE 16
 238
 239 /* Return the GDB type object for the "standard" data type of data in
 240    register N.  Perhaps si and di should go here, but potentially they
 241    could be used for things other than address.  */
 242
 243 #define REGISTER_VIRTUAL_TYPE(N)                                \
 244   (((N) == PC_REGNUM || (N) == FP_REGNUM || (N) == SP_REGNUM)   \
 245    ? lookup_pointer_type (builtin_type_void)                    \
 246    : IS_FP_REGNUM(N) ? builtin_type_long_double                 \
 247    : IS_SSE_REGNUM(N) ? builtin_type_v4sf                       \
 248    : builtin_type_int)
 249
 250 /* REGISTER_CONVERTIBLE(N) is true iff register N's virtual format is
 251    different from its raw format.  Note that this definition assumes
 252    that the host supports IEEE 32-bit floats, since it doesn't say
 253    that SSE registers need conversion.  Even if we can't find a
 254    counterexample, this is still sloppy.  */
 255 #define REGISTER_CONVERTIBLE(n) (IS_FP_REGNUM (n))
 256
 257 /* Convert data from raw format for register REGNUM in buffer FROM to
 258    virtual format with type TYPE in buffer TO.  */
 259
 260 #define REGISTER_CONVERT_TO_VIRTUAL(regnum, type, from, to) \
 261   i386_register_convert_to_virtual ((regnum), (type), (from), (to));
 262 extern void i386_register_convert_to_virtual (int regnum, struct type *type,
 263                                               char *from, char *to);
 264
 265 /* Convert data from virtual format with type TYPE in buffer FROM to
 266    raw format for register REGNUM in buffer TO.  */
 267
 268 #define REGISTER_CONVERT_TO_RAW(type, regnum, from, to) \
 269   i386_register_convert_to_raw ((type), (regnum), (from), (to));
 270 extern void i386_register_convert_to_raw (struct type *type, int regnum,
 271                                           char *from, char *to);
 272
 273 /* Print out the i387 floating point state.  */
 274 #ifdef HAVE_I387_REGS
 275 extern void i387_float_info (void);
 276 #define FLOAT_INFO { i387_float_info (); }
 277 #endif
 278
 279 \f
 280 /* Store the address of the place in which to copy the structure the
 281    subroutine will return.  This is called from call_function. */
 282
 283 #define STORE_STRUCT_RETURN(ADDR, SP) \
 284   { char buf[REGISTER_SIZE];    \
 285     (SP) -= sizeof (ADDR);      \
 286     store_address (buf, sizeof (ADDR), ADDR);   \
 287     write_memory ((SP), buf, sizeof (ADDR)); }
 288
 289 /* Extract from an array REGBUF containing the (raw) register state
 290    a function return value of type TYPE, and copy that, in virtual format,
 291    into VALBUF.  */
 292
 293 #define EXTRACT_RETURN_VALUE(type, regbuf, valbuf) \
 294   i386_extract_return_value ((type), (regbuf), (valbuf))
 295 extern void i386_extract_return_value (struct type *type, char *regbuf,
 296                                        char *valbuf);
 297
 298 /* Write into appropriate registers a function return value of type TYPE, given
 299    in virtual format.  */
 300
 301 #define STORE_RETURN_VALUE(TYPE,VALBUF) \
 302   {                                                                          \
 303     if (TYPE_CODE (TYPE) == TYPE_CODE_FLT)                                   \
 304       write_register_bytes (REGISTER_BYTE (FP0_REGNUM), (VALBUF),            \
 305                             TYPE_LENGTH (TYPE));                             \
 306     else                                                                     \
 307       write_register_bytes (0, (VALBUF), TYPE_LENGTH (TYPE));                \
 308   }
 309
 310 /* Extract from an array REGBUF containing the (raw) register state the address
 311    in which a function should return its structure value, as a CORE_ADDR (or an
 312    expression that can be used as one).  */
 313
 314 #define EXTRACT_STRUCT_VALUE_ADDRESS(REGBUF) (*(int *)(REGBUF))
 315
 316 /* The following redefines make backtracing through sigtramp work.
 317    They manufacture a fake sigtramp frame and obtain the saved pc in sigtramp
 318    from the sigcontext structure which is pushed by the kernel on the
 319    user stack, along with a pointer to it.  */
 320
 321 /* FRAME_CHAIN takes a frame's nominal address and produces the frame's
 322    chain-pointer.
 323    In the case of the i386, the frame's nominal address
 324    is the address of a 4-byte word containing the calling frame's address.  */
 325
 326 #define FRAME_CHAIN(thisframe)  \
 327   ((thisframe)->signal_handler_caller \
 328    ? (thisframe)->frame \
 329    : (!inside_entry_file ((thisframe)->pc) \
 330       ? read_memory_integer ((thisframe)->frame, 4) \
 331       : 0))
 332
 333 /* A macro that tells us whether the function invocation represented
 334    by FI does not have a frame on the stack associated with it.  If it
 335    does not, FRAMELESS is set to 1, else 0.  */
 336
 337 #define FRAMELESS_FUNCTION_INVOCATION(FI) \
 338      (((FI)->signal_handler_caller) ? 0 : frameless_look_for_prologue(FI))
 339
 340 /* Saved Pc.  Get it from sigcontext if within sigtramp.  */
 341
 342 #define FRAME_SAVED_PC(FRAME) \
 343   (((FRAME)->signal_handler_caller \
 344     ? sigtramp_saved_pc (FRAME) \
 345     : read_memory_integer ((FRAME)->frame + 4, 4)) \
 346    )
 347
 348 extern CORE_ADDR sigtramp_saved_pc (struct frame_info *);
 349
 350 #define FRAME_ARGS_ADDRESS(fi) ((fi)->frame)
 351
 352 #define FRAME_LOCALS_ADDRESS(fi) ((fi)->frame)
 353
 354 /* Return number of args passed to a frame.  Can return -1, meaning no way
 355    to tell, which is typical now that the C compiler delays popping them.  */
 356
 357 #define FRAME_NUM_ARGS(fi) (i386_frame_num_args(fi))
 358
 359 extern int i386_frame_num_args (struct frame_info *);
 360
 361 /* Return number of bytes at start of arglist that are not really args.  */
 362
 363 #define FRAME_ARGS_SKIP 8
 364
 365 /* Put here the code to store, into a struct frame_saved_regs,
 366    the addresses of the saved registers of frame described by FRAME_INFO.
 367    This includes special registers such as pc and fp saved in special
 368    ways in the stack frame.  sp is even more special:
 369    the address we return for it IS the sp for the next frame.  */
 370
 371 extern void i386_frame_init_saved_regs (struct frame_info *);
 372 #define FRAME_INIT_SAVED_REGS(FI) i386_frame_init_saved_regs (FI)
 373
 374 \f
 375
 376 /* Things needed for making the inferior call functions.  */
 377
 378 /* "An argument's size is increased, if necessary, to make it a
 379    multiple of [32 bit] words.  This may require tail padding,
 380    depending on the size of the argument" - from the x86 ABI.  */
 381 #define PARM_BOUNDARY 32
 382
 383 /* Push an empty stack frame, to record the current PC, etc.  */
 384
 385 #define PUSH_DUMMY_FRAME { i386_push_dummy_frame (); }
 386
 387 extern void i386_push_dummy_frame (void);
 388
 389 /* Discard from the stack the innermost frame, restoring all registers.  */
 390
 391 #define POP_FRAME  { i386_pop_frame (); }
 392
 393 extern void i386_pop_frame (void);
 394 \f
 395
 396 /* this is
 397  *   call 11223344 (32 bit relative)
 398  *   int3
 399  */
 400
 401 #define CALL_DUMMY { 0x223344e8, 0xcc11 }
 402
 403 #define CALL_DUMMY_LENGTH 8
 404
 405 #define CALL_DUMMY_START_OFFSET 0       /* Start execution at beginning of dummy */
 406
 407 #define CALL_DUMMY_BREAKPOINT_OFFSET 5
 408
 409 /* Insert the specified number of args and function address
 410    into a call sequence of the above form stored at DUMMYNAME.  */
 411
 412 #define FIX_CALL_DUMMY(dummyname, pc, fun, nargs, args, type, gcc_p) \
 413   i386_fix_call_dummy (dummyname, pc, fun, nargs, args, type, gcc_p)
 414 extern void i386_fix_call_dummy (char *dummy, CORE_ADDR pc, CORE_ADDR fun,
 415                                  int nargs, struct value **args,
 416                                  struct type *type, int gcc_p);
 417
 418 /* FIXME: kettenis/2000-06-12: These do not belong here.  */
 419 extern void print_387_control_word (unsigned int);
 420 extern void print_387_status_word (unsigned int);
 421
 422 /* Offset from SP to first arg on stack at first instruction of a function */
 423
 424 #define SP_ARG0 (1 * 4)
 425
 426 #endif /* ifndef TM_I386_H */