[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 3 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, see <http://www.gnu.org/licenses/>.  */

#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);

/* Return nonzero if a value of type TYPE stored in register REGNUM
   needs any special handling.  */

extern int i387_convert_register_p (int regnum, struct type *type);

/* 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 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);

/* 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
a9762ec7	10	the Free Software Foundation; either version 3 of the License, or
b2450fc5 MK	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
a9762ec7	19	along with this program. If not, see <http://www.gnu.org/licenses/>. */
b2450fc5	20
e750d25e JT	21	#ifndef I387_TDEP_H
e750d25e JT	22	#define I387_TDEP_H
b2450fc5	23
da3331ec	24	struct gdbarch;
da3331ec	25	struct frame_info;
41d041d6	26	struct regcache;
d532c08f	27	struct type;
41d041d6	28	struct ui_file;
da3331ec	29
5716833c MK	30	/* Because the number of general-purpose registers is different for
	31	AMD64, the floating-point registers and SSE registers get shifted.
	32	The following definitions are intended to help writing code that
	33	needs the register numbers of floating-point registers and SSE
	34	registers. In order to use these, one should provide a definition
	35	for I387_ST0_REGNUM, and possibly I387_NUM_XMM_REGS, preferably by
	36	using a local "#define" in the body of the function that uses this.
	37	Please "#undef" them before the end of the function. */
	38
	39	#define I387_FCTRL_REGNUM (I387_ST0_REGNUM + 8)
	40	#define I387_FSTAT_REGNUM (I387_FCTRL_REGNUM + 1)
	41	#define I387_FTAG_REGNUM (I387_FCTRL_REGNUM + 2)
	42	#define I387_FISEG_REGNUM (I387_FCTRL_REGNUM + 3)
	43	#define I387_FIOFF_REGNUM (I387_FCTRL_REGNUM + 4)
	44	#define I387_FOSEG_REGNUM (I387_FCTRL_REGNUM + 5)
	45	#define I387_FOOFF_REGNUM (I387_FCTRL_REGNUM + 6)
	46	#define I387_FOP_REGNUM (I387_FCTRL_REGNUM + 7)
	47	#define I387_XMM0_REGNUM (I387_ST0_REGNUM + 16)
	48	#define I387_MXCSR_REGNUM (I387_XMM0_REGNUM + I387_NUM_XMM_REGS)
	49	\f
	50
61113f8b MK	51	/* Print out the i387 floating point state. */
	52
	53	extern void i387_print_float_info (struct gdbarch *gdbarch,
	54	struct ui_file *file,
8e186fd6 AC	55	struct frame_info *frame,
8e186fd6 AC	56	const char *args);
61113f8b	57
83acabca DJ	58	/* Return nonzero if a value of type TYPE stored in register REGNUM
	59	needs any special handling. */
	60
	61	extern int i387_convert_register_p (int regnum, struct type *type);
	62
d532c08f MK	63	/* Read a value of type TYPE from register REGNUM in frame FRAME, and
	64	return its contents in TO. */
	65
	66	extern void i387_register_to_value (struct frame_info *frame, int regnum,
42835c2b	67	struct type type, gdb_byte to);
d532c08f MK	68
	69	/* Write the contents FROM of a value of type TYPE into register
	70	REGNUM in frame FRAME. */
	71
	72	extern void i387_value_to_register (struct frame_info *frame, int regnum,
42835c2b	73	struct type type, const gdb_byte from);
2de139ba MK	74	\f
	75
	76	/* Size of the memory area use by the 'fsave' and 'fxsave'
	77	instructions. */
	78	#define I387_SIZEOF_FSAVE 108
	79	#define I387_SIZEOF_FXSAVE 512
d532c08f	80
41d041d6 MK	81	/* Fill register REGNUM in REGCACHE with the appropriate value from
	82	*FSAVE. This function masks off any of the reserved bits in
	83	FSAVE. /
f31e928c	84
41d041d6 MK	85	extern void i387_supply_fsave (struct regcache *regcache, int regnum,
41d041d6 MK	86	const void *fsave);
b2450fc5	87
63b6c53f MK	88	/* Fill register REGNUM (if it is a floating-point register) in *FSAVE
	89	with the value from REGCACHE. If REGNUM is -1, do this for all
	90	registers. This function doesn't touch any of the reserved bits in
	91	FSAVE. /
	92
	93	extern void i387_collect_fsave (const struct regcache *regcache, int regnum,
	94	void *fsave);
	95
41d041d6	96	/* Fill register REGNUM in REGCACHE with the appropriate
ed504bdf MK	97	floating-point or SSE register value from *FXSAVE. This function
ed504bdf MK	98	masks off any of the reserved bits in FXSAVE. /
e2890f08	99
41d041d6 MK	100	extern void i387_supply_fxsave (struct regcache *regcache, int regnum,
41d041d6 MK	101	const void *fxsave);
e2890f08	102
80571bff MK	103	/* Fill register REGNUM (if it is a floating-point or SSE register) in
	104	*FXSAVE with the value from REGCACHE. If REGNUM is -1, do this for
	105	all registers. This function doesn't touch any of the reserved
	106	bits in FXSAVE. /
	107
	108	extern void i387_collect_fxsave (const struct regcache *regcache, int regnum,
	109	void *fxsave);
	110
efb1c01c MK	111	/* Prepare the FPU stack in REGCACHE for a function return. */
	112
	113	extern void i387_return_value (struct gdbarch *gdbarch,
	114	struct regcache *regcache);
	115
e750d25e	116	#endif /* i387-tdep.h */