[thirdparty/binutils-gdb.git] / gdb / i387-tdep.h

/* Target-dependent code for the i387.

   Copyright (C) 2000, 2001, 2002, 2003, 2004, 2007
   Free Software Foundation, Inc.

   This file is part of GDB.

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.  */

#ifndef I387_TDEP_H
#define I387_TDEP_H

struct gdbarch;
struct frame_info;
struct regcache;
struct type;
struct ui_file;

/* Because the number of general-purpose registers is different for
   AMD64, the floating-point registers and SSE registers get shifted.
   The following definitions are intended to help writing code that
   needs the register numbers of floating-point registers and SSE
   registers.  In order to use these, one should provide a definition
   for I387_ST0_REGNUM, and possibly I387_NUM_XMM_REGS, preferably by
   using a local "#define" in the body of the function that uses this.
   Please "#undef" them before the end of the function.  */

#define I387_FCTRL_REGNUM	(I387_ST0_REGNUM + 8)
#define I387_FSTAT_REGNUM	(I387_FCTRL_REGNUM + 1)
#define I387_FTAG_REGNUM	(I387_FCTRL_REGNUM + 2)
#define I387_FISEG_REGNUM	(I387_FCTRL_REGNUM + 3)
#define I387_FIOFF_REGNUM	(I387_FCTRL_REGNUM + 4)
#define I387_FOSEG_REGNUM	(I387_FCTRL_REGNUM + 5)
#define I387_FOOFF_REGNUM	(I387_FCTRL_REGNUM + 6)
#define I387_FOP_REGNUM		(I387_FCTRL_REGNUM + 7)
#define I387_XMM0_REGNUM	(I387_ST0_REGNUM + 16)
#define I387_MXCSR_REGNUM	(I387_XMM0_REGNUM + I387_NUM_XMM_REGS)
\f

/* Print out the i387 floating point state.  */

extern void i387_print_float_info (struct gdbarch *gdbarch,
				   struct ui_file *file,
				   struct frame_info *frame,
				   const char *args);

/* Read a value of type TYPE from register REGNUM in frame FRAME, and
   return its contents in TO.  */

extern void i387_register_to_value (struct frame_info *frame, int regnum,
				    struct type *type, gdb_byte *to);

/* Write the contents FROM of a value of type TYPE into register
   REGNUM in frame FRAME.  */

extern void i387_value_to_register (struct frame_info *frame, int regnum,
				    struct type *type, const gdb_byte *from);
\f

/* Size of the memory area use by the 'fsave' and 'fxsave'
   instructions.  */
#define I387_SIZEOF_FSAVE	108
#define I387_SIZEOF_FXSAVE	512

/* Fill register REGNUM in REGCACHE with the appropriate value from
   *FSAVE.  This function masks off any of the reserved bits in
   *FSAVE.  */

extern void i387_supply_fsave (struct regcache *regcache, int regnum,
			       const void *fsave);

/* Fill register REGNUM (if it is a floating-point register) in *FSAVE
   with the value from REGCACHE.  If REGNUM is -1, do this for all
   registers.  This function doesn't touch any of the reserved bits in
   *FSAVE.  */

extern void i387_collect_fsave (const struct regcache *regcache, int regnum,
				void *fsave);

/* Fill register REGNUM (if it is a floating-point register) in *FSAVE
   with the value in GDB's register cache.  If REGNUM is -1, do this
   for all registers.  This function doesn't touch any of the reserved
   bits in *FSAVE.  */

extern void i387_fill_fsave (void *fsave, int regnum);

/* Fill register REGNUM in REGCACHE with the appropriate
   floating-point or SSE register value from *FXSAVE.  This function
   masks off any of the reserved bits in *FXSAVE.  */

extern void i387_supply_fxsave (struct regcache *regcache, int regnum,
				const void *fxsave);

/* Fill register REGNUM (if it is a floating-point or SSE register) in
   *FXSAVE with the value from REGCACHE.  If REGNUM is -1, do this for
   all registers.  This function doesn't touch any of the reserved
   bits in *FXSAVE.  */

extern void i387_collect_fxsave (const struct regcache *regcache, int regnum,
				 void *fxsave);

/* Fill register REGNUM (if it is a floating-point or SSE register) in
   *FXSAVE with the value in GDB's register cache.  If REGNUM is -1, do
   this for all registers.  This function doesn't touch any of the
   reserved bits in *FXSAVE.  */

extern void i387_fill_fxsave (void *fxsave, int regnum);

/* Prepare the FPU stack in REGCACHE for a function return.  */

extern void i387_return_value (struct gdbarch *gdbarch,
			       struct regcache *regcache);

#endif /* i387-tdep.h */
Commit	Line	Data
e750d25e	1	/* Target-dependent code for the i387.
2de139ba	2
6aba47ca DJ	3	Copyright (C) 2000, 2001, 2002, 2003, 2004, 2007
6aba47ca DJ	4	Free Software Foundation, Inc.
b2450fc5 MK	5
	6	This file is part of GDB.
	7
	8	This program is free software; you can redistribute it and/or modify
	9	it under the terms of the GNU General Public License as published by
	10	the Free Software Foundation; either version 2 of the License, or
	11	(at your option) any later version.
	12
	13	This program is distributed in the hope that it will be useful,
	14	but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	GNU General Public License for more details.
	17
	18	You should have received a copy of the GNU General Public License
	19	along with this program; if not, write to the Free Software
197e01b6 EZ	20	Foundation, Inc., 51 Franklin Street, Fifth Floor,
197e01b6 EZ	21	Boston, MA 02110-1301, USA. */
b2450fc5	22
e750d25e JT	23	#ifndef I387_TDEP_H
e750d25e JT	24	#define I387_TDEP_H
b2450fc5	25
da3331ec	26	struct gdbarch;
da3331ec	27	struct frame_info;
41d041d6	28	struct regcache;
d532c08f	29	struct type;
41d041d6	30	struct ui_file;
da3331ec	31
5716833c MK	32	/* Because the number of general-purpose registers is different for
	33	AMD64, the floating-point registers and SSE registers get shifted.
	34	The following definitions are intended to help writing code that
	35	needs the register numbers of floating-point registers and SSE
	36	registers. In order to use these, one should provide a definition
	37	for I387_ST0_REGNUM, and possibly I387_NUM_XMM_REGS, preferably by
	38	using a local "#define" in the body of the function that uses this.
	39	Please "#undef" them before the end of the function. */
	40
	41	#define I387_FCTRL_REGNUM (I387_ST0_REGNUM + 8)
	42	#define I387_FSTAT_REGNUM (I387_FCTRL_REGNUM + 1)
	43	#define I387_FTAG_REGNUM (I387_FCTRL_REGNUM + 2)
	44	#define I387_FISEG_REGNUM (I387_FCTRL_REGNUM + 3)
	45	#define I387_FIOFF_REGNUM (I387_FCTRL_REGNUM + 4)
	46	#define I387_FOSEG_REGNUM (I387_FCTRL_REGNUM + 5)
	47	#define I387_FOOFF_REGNUM (I387_FCTRL_REGNUM + 6)
	48	#define I387_FOP_REGNUM (I387_FCTRL_REGNUM + 7)
	49	#define I387_XMM0_REGNUM (I387_ST0_REGNUM + 16)
	50	#define I387_MXCSR_REGNUM (I387_XMM0_REGNUM + I387_NUM_XMM_REGS)
	51	\f
	52
61113f8b MK	53	/* Print out the i387 floating point state. */
	54
	55	extern void i387_print_float_info (struct gdbarch *gdbarch,
	56	struct ui_file *file,
8e186fd6 AC	57	struct frame_info *frame,
8e186fd6 AC	58	const char *args);
61113f8b	59
d532c08f MK	60	/* Read a value of type TYPE from register REGNUM in frame FRAME, and
	61	return its contents in TO. */
	62
	63	extern void i387_register_to_value (struct frame_info *frame, int regnum,
42835c2b	64	struct type type, gdb_byte to);
d532c08f MK	65
	66	/* Write the contents FROM of a value of type TYPE into register
	67	REGNUM in frame FRAME. */
	68
	69	extern void i387_value_to_register (struct frame_info *frame, int regnum,
42835c2b	70	struct type type, const gdb_byte from);
2de139ba MK	71	\f
	72
	73	/* Size of the memory area use by the 'fsave' and 'fxsave'
	74	instructions. */
	75	#define I387_SIZEOF_FSAVE 108
	76	#define I387_SIZEOF_FXSAVE 512
d532c08f	77
41d041d6 MK	78	/* Fill register REGNUM in REGCACHE with the appropriate value from
	79	*FSAVE. This function masks off any of the reserved bits in
	80	FSAVE. /
f31e928c	81
41d041d6 MK	82	extern void i387_supply_fsave (struct regcache *regcache, int regnum,
41d041d6 MK	83	const void *fsave);
b2450fc5	84
63b6c53f MK	85	/* Fill register REGNUM (if it is a floating-point register) in *FSAVE
	86	with the value from REGCACHE. If REGNUM is -1, do this for all
	87	registers. This function doesn't touch any of the reserved bits in
	88	FSAVE. /
	89
	90	extern void i387_collect_fsave (const struct regcache *regcache, int regnum,
	91	void *fsave);
	92
f31e928c	93	/* Fill register REGNUM (if it is a floating-point register) in *FSAVE
ed504bdf	94	with the value in GDB's register cache. If REGNUM is -1, do this
b2450fc5 MK	95	for all registers. This function doesn't touch any of the reserved
	96	bits in FSAVE. /
	97
5716833c	98	extern void i387_fill_fsave (void *fsave, int regnum);
e2890f08	99
41d041d6	100	/* Fill register REGNUM in REGCACHE with the appropriate
ed504bdf MK	101	floating-point or SSE register value from *FXSAVE. This function
ed504bdf MK	102	masks off any of the reserved bits in FXSAVE. /
e2890f08	103
41d041d6 MK	104	extern void i387_supply_fxsave (struct regcache *regcache, int regnum,
41d041d6 MK	105	const void *fxsave);
e2890f08	106
80571bff MK	107	/* Fill register REGNUM (if it is a floating-point or SSE register) in
	108	*FXSAVE with the value from REGCACHE. If REGNUM is -1, do this for
	109	all registers. This function doesn't touch any of the reserved
	110	bits in FXSAVE. /
	111
	112	extern void i387_collect_fxsave (const struct regcache *regcache, int regnum,
	113	void *fxsave);
	114
f31e928c	115	/* Fill register REGNUM (if it is a floating-point or SSE register) in
ed504bdf	116	*FXSAVE with the value in GDB's register cache. If REGNUM is -1, do
e2890f08 MK	117	this for all registers. This function doesn't touch any of the
	118	reserved bits in FXSAVE. /
	119
5716833c	120	extern void i387_fill_fxsave (void *fxsave, int regnum);
b2450fc5	121
efb1c01c MK	122	/* Prepare the FPU stack in REGCACHE for a function return. */
	123
	124	extern void i387_return_value (struct gdbarch *gdbarch,
	125	struct regcache *regcache);
	126
e750d25e	127	#endif /* i387-tdep.h */