1/* Machine mode definitions for GCC; included by rtl.h and tree.h.
2   Copyright (C) 1991, 1993, 1994, 1996, 1998, 1999, 2000, 2001, 2003
3   Free Software Foundation, Inc.
4
5This file is part of GCC.
6
7GCC is free software; you can redistribute it and/or modify it under
8the terms of the GNU General Public License as published by the Free
9Software Foundation; either version 2, or (at your option) any later
10version.
11
12GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13WARRANTY; without even the implied warranty of MERCHANTABILITY or
14FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
15for more details.
16
17You should have received a copy of the GNU General Public License
18along with GCC; see the file COPYING.  If not, write to the Free
19Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA
2002110-1301, USA.  */
21
22#ifndef HAVE_MACHINE_MODES
23#define HAVE_MACHINE_MODES
24
25/* Make an enum class that gives all the machine modes.  */
26#include "insn-modes.h"
27
28/* Get the name of mode MODE as a string.  */
29
30extern const char * const mode_name[NUM_MACHINE_MODES];
31#define GET_MODE_NAME(MODE)  mode_name[MODE]
32
33/* Mode classes.  */
34
35#include "mode-classes.def"
36#define DEF_MODE_CLASS(M) M
37enum mode_class { MODE_CLASSES, MAX_MODE_CLASS };
38#undef DEF_MODE_CLASS
39#undef MODE_CLASSES
40
41/* Get the general kind of object that mode MODE represents
42   (integer, floating, complex, etc.)  */
43
44extern const unsigned char mode_class[NUM_MACHINE_MODES];
45#define GET_MODE_CLASS(MODE)  mode_class[MODE]
46
47/* Nonzero if MODE is an integral mode.  */
48#define INTEGRAL_MODE_P(MODE)			\
49  (GET_MODE_CLASS (MODE) == MODE_INT		\
50   || GET_MODE_CLASS (MODE) == MODE_PARTIAL_INT \
51   || GET_MODE_CLASS (MODE) == MODE_COMPLEX_INT \
52   || GET_MODE_CLASS (MODE) == MODE_VECTOR_INT)
53
54/* Nonzero if MODE is a floating-point mode.  */
55#define FLOAT_MODE_P(MODE)		\
56  (GET_MODE_CLASS (MODE) == MODE_FLOAT	\
57   || GET_MODE_CLASS (MODE) == MODE_DECIMAL_FLOAT \
58   || GET_MODE_CLASS (MODE) == MODE_COMPLEX_FLOAT \
59   || GET_MODE_CLASS (MODE) == MODE_VECTOR_FLOAT)
60
61/* Nonzero if MODE is a complex mode.  */
62#define COMPLEX_MODE_P(MODE)			\
63  (GET_MODE_CLASS (MODE) == MODE_COMPLEX_INT	\
64   || GET_MODE_CLASS (MODE) == MODE_COMPLEX_FLOAT)
65
66/* Nonzero if MODE is a vector mode.  */
67#define VECTOR_MODE_P(MODE)			\
68  (GET_MODE_CLASS (MODE) == MODE_VECTOR_INT	\
69   || GET_MODE_CLASS (MODE) == MODE_VECTOR_FLOAT)
70
71/* Nonzero if MODE is a scalar integral mode.  */
72#define SCALAR_INT_MODE_P(MODE)			\
73  (GET_MODE_CLASS (MODE) == MODE_INT		\
74   || GET_MODE_CLASS (MODE) == MODE_PARTIAL_INT)
75
76/* Nonzero if MODE is a scalar floating point mode.  */
77#define SCALAR_FLOAT_MODE_P(MODE)		\
78  (GET_MODE_CLASS (MODE) == MODE_FLOAT		\
79   || GET_MODE_CLASS (MODE) == MODE_DECIMAL_FLOAT)
80
81/* Nonzero if MODE is a decimal floating point mode.  */
82#define DECIMAL_FLOAT_MODE_P(MODE)		\
83  (GET_MODE_CLASS (MODE) == MODE_DECIMAL_FLOAT)
84
85/* Nonzero if CLASS modes can be widened.  */
86#define CLASS_HAS_WIDER_MODES_P(CLASS)         \
87  (CLASS == MODE_INT                           \
88   || CLASS == MODE_FLOAT                      \
89   || CLASS == MODE_DECIMAL_FLOAT              \
90   || CLASS == MODE_COMPLEX_FLOAT)
91
92/* Get the size in bytes and bits of an object of mode MODE.  */
93
94extern CONST_MODE_SIZE unsigned char mode_size[NUM_MACHINE_MODES];
95#define GET_MODE_SIZE(MODE)    ((unsigned short) mode_size[MODE])
96#define GET_MODE_BITSIZE(MODE) ((unsigned short) (GET_MODE_SIZE (MODE) * BITS_PER_UNIT))
97
98/* Get the number of value bits of an object of mode MODE.  */
99extern const unsigned short mode_precision[NUM_MACHINE_MODES];
100#define GET_MODE_PRECISION(MODE)  mode_precision[MODE]
101
102/* Get a bitmask containing 1 for all bits in a word
103   that fit within mode MODE.  */
104
105extern const unsigned HOST_WIDE_INT mode_mask_array[NUM_MACHINE_MODES];
106
107#define GET_MODE_MASK(MODE) mode_mask_array[MODE]
108
109/* Return the mode of the inner elements in a vector.  */
110
111extern const unsigned char mode_inner[NUM_MACHINE_MODES];
112#define GET_MODE_INNER(MODE) mode_inner[MODE]
113
114/* Get the size in bytes of the basic parts of an object of mode MODE.  */
115
116#define GET_MODE_UNIT_SIZE(MODE)		\
117  (GET_MODE_INNER (MODE) == VOIDmode		\
118   ? GET_MODE_SIZE (MODE)			\
119   : GET_MODE_SIZE (GET_MODE_INNER (MODE)))
120
121/* Get the number of units in the object.  */
122
123extern const unsigned char mode_nunits[NUM_MACHINE_MODES];
124#define GET_MODE_NUNITS(MODE)  mode_nunits[MODE]
125
126/* Get the next wider natural mode (eg, QI -> HI -> SI -> DI -> TI).  */
127
128extern const unsigned char mode_wider[NUM_MACHINE_MODES];
129#define GET_MODE_WIDER_MODE(MODE) mode_wider[MODE]
130
131extern const unsigned char mode_2xwider[NUM_MACHINE_MODES];
132#define GET_MODE_2XWIDER_MODE(MODE) mode_2xwider[MODE]
133
134/* Return the mode for data of a given size SIZE and mode class CLASS.
135   If LIMIT is nonzero, then don't use modes bigger than MAX_FIXED_MODE_SIZE.
136   The value is BLKmode if no other mode is found.  */
137
138extern enum machine_mode mode_for_size (unsigned int, enum mode_class, int);
139
140/* Similar, but find the smallest mode for a given width.  */
141
142extern enum machine_mode smallest_mode_for_size (unsigned int,
143						 enum mode_class);
144
145
146/* Return an integer mode of the exact same size as the input mode,
147   or BLKmode on failure.  */
148
149extern enum machine_mode int_mode_for_mode (enum machine_mode);
150
151/* Find the best mode to use to access a bit field.  */
152
153extern enum machine_mode get_best_mode (int, int, unsigned int,
154					enum machine_mode, int);
155
156/* Determine alignment, 1<=result<=BIGGEST_ALIGNMENT.  */
157
158extern CONST_MODE_BASE_ALIGN unsigned char mode_base_align[NUM_MACHINE_MODES];
159
160extern unsigned get_mode_alignment (enum machine_mode);
161
162#define GET_MODE_ALIGNMENT(MODE) get_mode_alignment (MODE)
163
164/* For each class, get the narrowest mode in that class.  */
165
166extern const unsigned char class_narrowest_mode[MAX_MODE_CLASS];
167#define GET_CLASS_NARROWEST_MODE(CLASS) class_narrowest_mode[CLASS]
168
169/* Define the integer modes whose sizes are BITS_PER_UNIT and BITS_PER_WORD
170   and the mode whose class is Pmode and whose size is POINTER_SIZE.  */
171
172extern enum machine_mode byte_mode;
173extern enum machine_mode word_mode;
174extern enum machine_mode ptr_mode;
175
176/* Target-dependent machine mode initialization - in insn-modes.c.  */
177extern void init_adjust_machine_modes (void);
178
179#endif /* not HAVE_MACHINE_MODES */
180