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, 59 Temple Place - Suite 330, Boston, MA
  20 02111-1307, 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
  27 #define DEF_MACHMODE(SYM, NAME, TYPE, BITSIZE, SIZE, UNIT, WIDER, INNER)  SYM,
  28
  29 enum machine_mode {
  30 #include "machmode.def"
  31 MAX_MACHINE_MODE };
  32
  33 #undef DEF_MACHMODE
  34
  35 #ifndef NUM_MACHINE_MODES
  36 #define NUM_MACHINE_MODES (int) MAX_MACHINE_MODE
  37 #endif
  38
  39 /* Get the name of mode MODE as a string.  */
  40
  41 extern const char * const mode_name[NUM_MACHINE_MODES];
  42 #define GET_MODE_NAME(MODE)             (mode_name[(int) (MODE)])
  43
  44 enum mode_class { MODE_RANDOM, MODE_INT, MODE_FLOAT, MODE_PARTIAL_INT, MODE_CC,
  45                   MODE_COMPLEX_INT, MODE_COMPLEX_FLOAT,
  46                   MODE_VECTOR_INT, MODE_VECTOR_FLOAT,
  47                   MAX_MODE_CLASS};
  48
  49 /* Get the general kind of object that mode MODE represents
  50    (integer, floating, complex, etc.)  */
  51
  52 extern const enum mode_class mode_class[NUM_MACHINE_MODES];
  53 #define GET_MODE_CLASS(MODE)            (mode_class[(int) (MODE)])
  54
  55 /* Nonzero if MODE is an integral mode.  */
  56 #define INTEGRAL_MODE_P(MODE)                   \
  57   (GET_MODE_CLASS (MODE) == MODE_INT            \
  58    || GET_MODE_CLASS (MODE) == MODE_PARTIAL_INT \
  59    || GET_MODE_CLASS (MODE) == MODE_COMPLEX_INT \
  60    || GET_MODE_CLASS (MODE) == MODE_VECTOR_INT)
  61
  62 /* Nonzero if MODE is a floating-point mode.  */
  63 #define FLOAT_MODE_P(MODE)              \
  64   (GET_MODE_CLASS (MODE) == MODE_FLOAT  \
  65    || GET_MODE_CLASS (MODE) == MODE_COMPLEX_FLOAT \
  66    || GET_MODE_CLASS (MODE) == MODE_VECTOR_FLOAT)
  67
  68 /* Nonzero if MODE is a complex mode.  */
  69 #define COMPLEX_MODE_P(MODE)                    \
  70   (GET_MODE_CLASS (MODE) == MODE_COMPLEX_INT    \
  71    || GET_MODE_CLASS (MODE) == MODE_COMPLEX_FLOAT)
  72
  73 /* Nonzero if MODE is a vector mode.  */
  74 #define VECTOR_MODE_P(MODE)                     \
  75   (GET_MODE_CLASS (MODE) == MODE_VECTOR_INT     \
  76    || GET_MODE_CLASS (MODE) == MODE_VECTOR_FLOAT)
  77
  78 /* Nonzero if MODE is a scalar integral mode.  */
  79 #define SCALAR_INT_MODE_P(MODE)                 \
  80   (GET_MODE_CLASS (MODE) == MODE_INT            \
  81    || GET_MODE_CLASS (MODE) == MODE_PARTIAL_INT)
  82
  83 /* Nonzero if MODE is a scalar floating point mode.  */
  84 #define SCALAR_FLOAT_MODE_P(MODE)               \
  85   (GET_MODE_CLASS (MODE) == MODE_FLOAT)
  86
  87 /* Get the size in bytes of an object of mode MODE.  */
  88
  89 extern const unsigned char mode_size[NUM_MACHINE_MODES];
  90 #define GET_MODE_SIZE(MODE)             (mode_size[(int) (MODE)])
  91
  92 /* Get the size in bytes of the basic parts of an object of mode MODE.  */
  93
  94 extern const unsigned char mode_unit_size[NUM_MACHINE_MODES];
  95 #define GET_MODE_UNIT_SIZE(MODE)        (mode_unit_size[(int) (MODE)])
  96
  97 /* Get the number of units in the object.  */
  98
  99 #define GET_MODE_NUNITS(MODE)  \
 100   ((GET_MODE_UNIT_SIZE ((MODE)) == 0) ? 0 \
 101    : (GET_MODE_SIZE ((MODE)) / GET_MODE_UNIT_SIZE ((MODE))))
 102
 103 /* Get the size in bits of an object of mode MODE.  */
 104
 105 extern const unsigned short mode_bitsize[NUM_MACHINE_MODES];
 106 #define GET_MODE_BITSIZE(MODE)  (mode_bitsize[(int) (MODE)])
 107
 108 #endif /* not HAVE_MACHINE_MODES */
 109
 110 #if defined HOST_WIDE_INT && ! defined GET_MODE_MASK
 111
 112 /* Get a bitmask containing 1 for all bits in a word
 113    that fit within mode MODE.  */
 114
 115 extern const unsigned HOST_WIDE_INT mode_mask_array[NUM_MACHINE_MODES];
 116
 117 #define GET_MODE_MASK(MODE) mode_mask_array[(int) (MODE)]
 118
 119 extern const enum machine_mode inner_mode_array[NUM_MACHINE_MODES];
 120
 121 /* Return the mode of the inner elements in a vector.  */
 122
 123 #define GET_MODE_INNER(MODE) inner_mode_array[(int) (MODE)]
 124
 125 #endif /* defined (HOST_WIDE_INT) && ! defined GET_MODE_MASK */
 126
 127 #if ! defined GET_MODE_WIDER_MODE || ! defined GET_MODE_ALIGNMENT \
 128     || ! defined GET_CLASS_NARROWEST_MODE
 129
 130 /* Get the next wider natural mode (eg, QI -> HI -> SI -> DI -> TI).  */
 131
 132 extern const unsigned char mode_wider_mode[NUM_MACHINE_MODES];
 133 #define GET_MODE_WIDER_MODE(MODE)       ((enum machine_mode)mode_wider_mode[(int) (MODE)])
 134
 135 /* Return the mode for data of a given size SIZE and mode class CLASS.
 136    If LIMIT is nonzero, then don't use modes bigger than MAX_FIXED_MODE_SIZE.
 137    The value is BLKmode if no other mode is found.  */
 138
 139 extern enum machine_mode mode_for_size (unsigned int, enum mode_class, int);
 140
 141 /* Similar, but find the smallest mode for a given width.  */
 142
 143 extern enum machine_mode smallest_mode_for_size (unsigned int,
 144                                                  enum mode_class);
 145
 146
 147 /* Return an integer mode of the exact same size as the input mode,
 148    or BLKmode on failure.  */
 149
 150 extern enum machine_mode int_mode_for_mode (enum machine_mode);
 151
 152 /* Find the best mode to use to access a bit field.  */
 153
 154 extern enum machine_mode get_best_mode (int, int, unsigned int,
 155                                         enum machine_mode, int);
 156
 157 /* Determine alignment, 1<=result<=BIGGEST_ALIGNMENT.  */
 158
 159 extern unsigned get_mode_alignment (enum machine_mode);
 160
 161 #define GET_MODE_ALIGNMENT(MODE) get_mode_alignment (MODE)
 162
 163 /* For each class, get the narrowest mode in that class.  */
 164
 165 extern const enum machine_mode class_narrowest_mode[(int) MAX_MODE_CLASS];
 166 #define GET_CLASS_NARROWEST_MODE(CLASS) class_narrowest_mode[(int) (CLASS)]
 167
 168 /* Define the integer modes whose sizes are BITS_PER_UNIT and BITS_PER_WORD
 169    and the mode whose class is Pmode and whose size is POINTER_SIZE.  */
 170
 171 extern enum machine_mode byte_mode;
 172 extern enum machine_mode word_mode;
 173 extern enum machine_mode ptr_mode;
 174
 175 #endif /* ! defined GET_MODE_WIDER_MODE || ! defined GET_MODE_ALIGNMENT
 176           || ! defined GET_CLASS_NARROWEST_MODE */