gdb/config/i386/tm-i386.h

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