[gcc.git] / gcc / machmode.h

/* Machine mode definitions for GNU C-Compiler; included by rtl.h and tree.h.
   Copyright (C) 1991  Free Software Foundation, Inc.

This file is part of GNU CC.

GNU CC 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, or (at your option)
any later version.

GNU CC 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 GNU CC; see the file COPYING.  If not, write to
the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */


/* Add prototype support.  */
#ifndef PROTO
#if defined (USE_PROTOTYPES) ? USE_PROTOTYPES : defined (__STDC__)
#define PROTO(ARGS) ARGS
#else
#define PROTO(ARGS) ()
#endif
#endif

#ifndef HAVE_MACHINE_MODES

/* Strictly speaking, this isn't the proper place to include these definitions,
   but this file is included by every GCC file.

   Some systems define these in, e.g., param.h.  We undefine these names
   here to avoid the warnings.  We prefer to use our definitions since we
   know they are correct.  */

#undef MIN
#undef MAX

#define MIN(X,Y) ((X) < (Y) ? (X) : (Y))
#define MAX(X,Y) ((X) > (Y) ? (X) : (Y))

/* Find the largest host integer type and set its size and type.  */

#ifndef HOST_BITS_PER_WIDE_INT

#if HOST_BITS_PER_LONG > HOST_BITS_PER_INT
#define HOST_BITS_PER_WIDE_INT HOST_BITS_PER_LONG
#define HOST_WIDE_INT long
#else
#define HOST_BITS_PER_WIDE_INT HOST_BITS_PER_INT
#define HOST_WIDE_INT int
#endif

#endif

/* Define the number of entries in an 8-bit `shorts' array needed to represent
   the largest supported constant, which is twice the width of the largest
   host integer type.  */

#ifndef MAX_SHORTS
#define MAX_SHORTS (HOST_BITS_PER_WIDE_INT * 2 / 8)
#endif

/* Provide a default way to print an address in hex via printf.  */

#ifndef HOST_PTR_PRINTF
#define HOST_PTR_PRINTF sizeof (int) == sizeof (char *) ? "%x" : "%lx"
#endif

/* Make an enum class that gives all the machine modes.  */

#define DEF_MACHMODE(SYM, NAME, TYPE, SIZE, UNIT, WIDER)  SYM,

enum machine_mode {
#include "machmode.def"

#ifdef EXTRA_CC_MODES
  EXTRA_CC_MODES,
#endif
MAX_MACHINE_MODE };

#undef DEF_MACHMODE

#define HAVE_MACHINE_MODES

#ifndef NUM_MACHINE_MODES
#define NUM_MACHINE_MODES (int) MAX_MACHINE_MODE
#endif

/* Get the name of mode MODE as a string.  */

extern char *mode_name[];
#define GET_MODE_NAME(MODE)		(mode_name[(int)(MODE)])

enum mode_class { MODE_RANDOM, MODE_INT, MODE_FLOAT, MODE_PARTIAL_INT, MODE_CC,
		  MODE_COMPLEX_INT, MODE_COMPLEX_FLOAT, MAX_MODE_CLASS};

/* Get the general kind of object that mode MODE represents
   (integer, floating, complex, etc.)  */

extern enum mode_class mode_class[];
#define GET_MODE_CLASS(MODE)		(mode_class[(int)(MODE)])

/* Get the size in bytes of an object of mode MODE.  */

extern int mode_size[];
#define GET_MODE_SIZE(MODE)		(mode_size[(int)(MODE)])

/* Get the size in bytes of the basic parts of an object of mode MODE.  */

extern int mode_unit_size[];
#define GET_MODE_UNIT_SIZE(MODE)	(mode_unit_size[(int)(MODE)])

/* Get the number of units in the object.  */

#define GET_MODE_NUNITS(MODE)  \
  ((GET_MODE_UNIT_SIZE ((MODE)) == 0) ? 0 \
   : (GET_MODE_SIZE ((MODE)) / GET_MODE_UNIT_SIZE ((MODE))))

/* Get the size in bits of an object of mode MODE.  */

#define GET_MODE_BITSIZE(MODE)  (BITS_PER_UNIT * mode_size[(int)(MODE)])

/* Get a bitmask containing 1 for all bits in a word
   that fit within mode MODE.  */

#define GET_MODE_MASK(MODE)  \
   ((GET_MODE_BITSIZE (MODE) >= HOST_BITS_PER_WIDE_INT)  \
    ?(HOST_WIDE_INT) ~0 : (((HOST_WIDE_INT) 1 << GET_MODE_BITSIZE (MODE)) - 1))

/* Get the next wider natural mode (eg, QI -> HI -> SI -> DI -> TI).  */

extern enum machine_mode mode_wider_mode[];
#define GET_MODE_WIDER_MODE(MODE)	(mode_wider_mode[(int)(MODE)])

/* Return the mode for data of a given size SIZE and mode class CLASS.
   If LIMIT is nonzero, then don't use modes bigger than MAX_FIXED_MODE_SIZE.
   The value is BLKmode if no other mode is found.  */

extern enum machine_mode mode_for_size PROTO((unsigned int, enum mode_class, int));

/* Find the best mode to use to access a bit field.  */

extern enum machine_mode get_best_mode PROTO((int, int, int, enum machine_mode, int));

/* Determine alignment, 1<=result<=BIGGEST_ALIGNMENT.  */

#define GET_MODE_ALIGNMENT(MODE)   \
  MIN (BIGGEST_ALIGNMENT, 	   \
       MAX (1, (GET_MODE_UNIT_SIZE (MODE) * BITS_PER_UNIT)))

/* For each class, get the narrowest mode in that class.  */

extern enum machine_mode class_narrowest_mode[];
#define GET_CLASS_NARROWEST_MODE(CLASS) class_narrowest_mode[(int)(CLASS)]

/* Define the integer modes whose sizes are BITS_PER_UNIT
   and BITS_PER_WORD.  */

extern enum machine_mode byte_mode;
extern enum machine_mode word_mode;

#endif /* not HAVE_MACHINE_MODES */
Commit	Line	Data
fc152a4b	1	/* Machine mode definitions for GNU C-Compiler; included by rtl.h and tree.h.
a8efe40d	2	Copyright (C) 1991 Free Software Foundation, Inc.
fc152a4b RK	3
	4	This file is part of GNU CC.
	5
	6	GNU CC 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, or (at your option)
	9	any later version.
	10
	11	GNU CC 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 GNU CC; see the file COPYING. If not, write to
	18	the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
	19
	20
521f2d6f JW	21	/* Add prototype support. */
	22	#ifndef PROTO
	23	#if defined (USE_PROTOTYPES) ? USE_PROTOTYPES : defined (__STDC__)
	24	#define PROTO(ARGS) ARGS
	25	#else
	26	#define PROTO(ARGS) ()
	27	#endif
	28	#endif
	29
fc152a4b RK	30	#ifndef HAVE_MACHINE_MODES
	31
	32	/* Strictly speaking, this isn't the proper place to include these definitions,
	33	but this file is included by every GCC file.
	34
	35	Some systems define these in, e.g., param.h. We undefine these names
	36	here to avoid the warnings. We prefer to use our definitions since we
	37	know they are correct. */
	38
	39	#undef MIN
	40	#undef MAX
	41
	42	#define MIN(X,Y) ((X) < (Y) ? (X) : (Y))
	43	#define MAX(X,Y) ((X) > (Y) ? (X) : (Y))
	44
5f4f0e22 CH	45	/* Find the largest host integer type and set its size and type. */
	46
	47	#ifndef HOST_BITS_PER_WIDE_INT
	48
	49	#if HOST_BITS_PER_LONG > HOST_BITS_PER_INT
	50	#define HOST_BITS_PER_WIDE_INT HOST_BITS_PER_LONG
	51	#define HOST_WIDE_INT long
	52	#else
	53	#define HOST_BITS_PER_WIDE_INT HOST_BITS_PER_INT
	54	#define HOST_WIDE_INT int
	55	#endif
	56
	57	#endif
	58
	59	/* Define the number of entries in an 8-bit `shorts' array needed to represent
	60	the largest supported constant, which is twice the width of the largest
	61	host integer type. */
	62
	63	#ifndef MAX_SHORTS
	64	#define MAX_SHORTS (HOST_BITS_PER_WIDE_INT * 2 / 8)
	65	#endif
	66
	67	/* Provide a default way to print an address in hex via printf. */
	68
	69	#ifndef HOST_PTR_PRINTF
	70	#define HOST_PTR_PRINTF sizeof (int) == sizeof (char *) ? "%x" : "%lx"
	71	#endif
	72
fc152a4b RK	73	/* Make an enum class that gives all the machine modes. */
	74
	75	#define DEF_MACHMODE(SYM, NAME, TYPE, SIZE, UNIT, WIDER) SYM,
	76
	77	enum machine_mode {
	78	#include "machmode.def"
	79
	80	#ifdef EXTRA_CC_MODES
	81	EXTRA_CC_MODES,
	82	#endif
	83	MAX_MACHINE_MODE };
	84
	85	#undef DEF_MACHMODE
	86
	87	#define HAVE_MACHINE_MODES
	88
	89	#ifndef NUM_MACHINE_MODES
	90	#define NUM_MACHINE_MODES (int) MAX_MACHINE_MODE
	91	#endif
	92
	93	/* Get the name of mode MODE as a string. */
	94
	95	extern char *mode_name[];
	96	#define GET_MODE_NAME(MODE) (mode_name[(int)(MODE)])
	97
	98	enum mode_class { MODE_RANDOM, MODE_INT, MODE_FLOAT, MODE_PARTIAL_INT, MODE_CC,
4a39a918	99	MODE_COMPLEX_INT, MODE_COMPLEX_FLOAT, MAX_MODE_CLASS};
fc152a4b RK	100
	101	/* Get the general kind of object that mode MODE represents
	102	(integer, floating, complex, etc.) */
	103
	104	extern enum mode_class mode_class[];
	105	#define GET_MODE_CLASS(MODE) (mode_class[(int)(MODE)])
	106
	107	/* Get the size in bytes of an object of mode MODE. */
	108
	109	extern int mode_size[];
	110	#define GET_MODE_SIZE(MODE) (mode_size[(int)(MODE)])
	111
	112	/* Get the size in bytes of the basic parts of an object of mode MODE. */
	113
	114	extern int mode_unit_size[];
	115	#define GET_MODE_UNIT_SIZE(MODE) (mode_unit_size[(int)(MODE)])
	116
	117	/* Get the number of units in the object. */
	118
	119	#define GET_MODE_NUNITS(MODE) \
fa45b1eb RS	120	((GET_MODE_UNIT_SIZE ((MODE)) == 0) ? 0 \
fa45b1eb RS	121	: (GET_MODE_SIZE ((MODE)) / GET_MODE_UNIT_SIZE ((MODE))))
fc152a4b RK	122
	123	/* Get the size in bits of an object of mode MODE. */
	124
	125	#define GET_MODE_BITSIZE(MODE) (BITS_PER_UNIT * mode_size[(int)(MODE)])
	126
	127	/* Get a bitmask containing 1 for all bits in a word
	128	that fit within mode MODE. */
	129
	130	#define GET_MODE_MASK(MODE) \
5f4f0e22 CH	131	((GET_MODE_BITSIZE (MODE) >= HOST_BITS_PER_WIDE_INT) \
5f4f0e22 CH	132	?(HOST_WIDE_INT) ~0 : (((HOST_WIDE_INT) 1 << GET_MODE_BITSIZE (MODE)) - 1))
fc152a4b RK	133
	134	/* Get the next wider natural mode (eg, QI -> HI -> SI -> DI -> TI). */
	135
	136	extern enum machine_mode mode_wider_mode[];
	137	#define GET_MODE_WIDER_MODE(MODE) (mode_wider_mode[(int)(MODE)])
	138
c92c981a RK	139	/* Return the mode for data of a given size SIZE and mode class CLASS.
	140	If LIMIT is nonzero, then don't use modes bigger than MAX_FIXED_MODE_SIZE.
	141	The value is BLKmode if no other mode is found. */
	142
521f2d6f	143	extern enum machine_mode mode_for_size PROTO((unsigned int, enum mode_class, int));
c92c981a	144
fc152a4b RK	145	/* Find the best mode to use to access a bit field. */
fc152a4b RK	146
521f2d6f	147	extern enum machine_mode get_best_mode PROTO((int, int, int, enum machine_mode, int));
fc152a4b RK	148
	149	/* Determine alignment, 1<=result<=BIGGEST_ALIGNMENT. */
	150
	151	#define GET_MODE_ALIGNMENT(MODE) \
	152	MIN (BIGGEST_ALIGNMENT, \
	153	MAX (1, (GET_MODE_UNIT_SIZE (MODE) * BITS_PER_UNIT)))
	154
4a39a918 RK	155	/* For each class, get the narrowest mode in that class. */
	156
	157	extern enum machine_mode class_narrowest_mode[];
	158	#define GET_CLASS_NARROWEST_MODE(CLASS) class_narrowest_mode[(int)(CLASS)]
	159
	160	/* Define the integer modes whose sizes are BITS_PER_UNIT
	161	and BITS_PER_WORD. */
	162
	163	extern enum machine_mode byte_mode;
	164	extern enum machine_mode word_mode;
	165
fc152a4b	166	#endif /* not HAVE_MACHINE_MODES */