machmode.h (CLASS_HAS_WIDER_MODES_P): New macro.
[gcc.git] / gcc / machmode.h
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
5 This file is part of GCC.
6
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 2, or (at your option) any later
10 version.
11
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING. If not, write to the Free
19 Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA
20 02110-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
30 extern 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
37 enum 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
44 extern 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_COMPLEX_FLOAT \
58 || GET_MODE_CLASS (MODE) == MODE_VECTOR_FLOAT)
59
60 /* Nonzero if MODE is a complex mode. */
61 #define COMPLEX_MODE_P(MODE) \
62 (GET_MODE_CLASS (MODE) == MODE_COMPLEX_INT \
63 || GET_MODE_CLASS (MODE) == MODE_COMPLEX_FLOAT)
64
65 /* Nonzero if MODE is a vector mode. */
66 #define VECTOR_MODE_P(MODE) \
67 (GET_MODE_CLASS (MODE) == MODE_VECTOR_INT \
68 || GET_MODE_CLASS (MODE) == MODE_VECTOR_FLOAT)
69
70 /* Nonzero if MODE is a scalar integral mode. */
71 #define SCALAR_INT_MODE_P(MODE) \
72 (GET_MODE_CLASS (MODE) == MODE_INT \
73 || GET_MODE_CLASS (MODE) == MODE_PARTIAL_INT)
74
75 /* Nonzero if MODE is a scalar floating point mode. */
76 #define SCALAR_FLOAT_MODE_P(MODE) \
77 (GET_MODE_CLASS (MODE) == MODE_FLOAT)
78
79 /* Nonzero if CLASS modes can be widened. */
80 #define CLASS_HAS_WIDER_MODES_P(CLASS) \
81 (CLASS == MODE_INT \
82 || CLASS == MODE_FLOAT \
83 || CLASS == MODE_COMPLEX_FLOAT)
84
85 /* Get the size in bytes and bits of an object of mode MODE. */
86
87 extern CONST_MODE_SIZE unsigned char mode_size[NUM_MACHINE_MODES];
88 #define GET_MODE_SIZE(MODE) ((unsigned short) mode_size[MODE])
89 #define GET_MODE_BITSIZE(MODE) ((unsigned short) (GET_MODE_SIZE (MODE) * BITS_PER_UNIT))
90
91 /* Get the number of value bits of an object of mode MODE. */
92 extern const unsigned short mode_precision[NUM_MACHINE_MODES];
93 #define GET_MODE_PRECISION(MODE) mode_precision[MODE]
94
95 /* Get a bitmask containing 1 for all bits in a word
96 that fit within mode MODE. */
97
98 extern const unsigned HOST_WIDE_INT mode_mask_array[NUM_MACHINE_MODES];
99
100 #define GET_MODE_MASK(MODE) mode_mask_array[MODE]
101
102 /* Return the mode of the inner elements in a vector. */
103
104 extern const unsigned char mode_inner[NUM_MACHINE_MODES];
105 #define GET_MODE_INNER(MODE) mode_inner[MODE]
106
107 /* Get the size in bytes of the basic parts of an object of mode MODE. */
108
109 #define GET_MODE_UNIT_SIZE(MODE) \
110 (GET_MODE_INNER (MODE) == VOIDmode \
111 ? GET_MODE_SIZE (MODE) \
112 : GET_MODE_SIZE (GET_MODE_INNER (MODE)))
113
114 /* Get the number of units in the object. */
115
116 extern const unsigned char mode_nunits[NUM_MACHINE_MODES];
117 #define GET_MODE_NUNITS(MODE) mode_nunits[MODE]
118
119 /* Get the next wider natural mode (eg, QI -> HI -> SI -> DI -> TI). */
120
121 extern const unsigned char mode_wider[NUM_MACHINE_MODES];
122 #define GET_MODE_WIDER_MODE(MODE) mode_wider[MODE]
123
124 extern const unsigned char mode_2xwider[NUM_MACHINE_MODES];
125 #define GET_MODE_2XWIDER_MODE(MODE) mode_2xwider[MODE]
126
127 /* Return the mode for data of a given size SIZE and mode class CLASS.
128 If LIMIT is nonzero, then don't use modes bigger than MAX_FIXED_MODE_SIZE.
129 The value is BLKmode if no other mode is found. */
130
131 extern enum machine_mode mode_for_size (unsigned int, enum mode_class, int);
132
133 /* Similar, but find the smallest mode for a given width. */
134
135 extern enum machine_mode smallest_mode_for_size (unsigned int,
136 enum mode_class);
137
138
139 /* Return an integer mode of the exact same size as the input mode,
140 or BLKmode on failure. */
141
142 extern enum machine_mode int_mode_for_mode (enum machine_mode);
143
144 /* Find the best mode to use to access a bit field. */
145
146 extern enum machine_mode get_best_mode (int, int, unsigned int,
147 enum machine_mode, int);
148
149 /* Determine alignment, 1<=result<=BIGGEST_ALIGNMENT. */
150
151 extern CONST_MODE_BASE_ALIGN unsigned char mode_base_align[NUM_MACHINE_MODES];
152
153 extern unsigned get_mode_alignment (enum machine_mode);
154
155 #define GET_MODE_ALIGNMENT(MODE) get_mode_alignment (MODE)
156
157 /* For each class, get the narrowest mode in that class. */
158
159 extern const unsigned char class_narrowest_mode[MAX_MODE_CLASS];
160 #define GET_CLASS_NARROWEST_MODE(CLASS) class_narrowest_mode[CLASS]
161
162 /* Define the integer modes whose sizes are BITS_PER_UNIT and BITS_PER_WORD
163 and the mode whose class is Pmode and whose size is POINTER_SIZE. */
164
165 extern enum machine_mode byte_mode;
166 extern enum machine_mode word_mode;
167 extern enum machine_mode ptr_mode;
168
169 /* Target-dependent machine mode initialization - in insn-modes.c. */
170 extern void init_adjust_machine_modes (void);
171
172 #endif /* not HAVE_MACHINE_MODES */