remove symconst_type_tag
[libfirm] / include / libfirm / irmode.h
index 4fcd309..cb26aca 100644 (file)
@@ -22,7 +22,6 @@
  * @brief   Data modes of operations.
  * @author  Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Mathias Heil,
  *          Michael Beck
- * @version $Id$
  * @brief
  *  This module specifies the modes that type the firm nodes.  It defines
  *  a datasturcture that describes a mode and implements constructors and
 #include "firm_types.h"
 #include "begin.h"
 
-/** Helper values for ir_mode_sort. */
-enum ir_mode_sort_helper {
-       irmsh_is_num   = 0x10, /**< mode represents a number */
-       irmsh_is_data  = 0x20, /**< mode represents data (can be carried in registers) */
-       irmsh_is_datab = 0x40, /**< mode represents data or is internal boolean */
-       irmsh_is_dataM = 0x80, /**< mode represents data or is memory */
-};
-
-/**
- * These values represent the different mode classes of value representations.
- * Beware: do not change the order of these values without checking
- * the mode_is
- */
-typedef enum ir_mode_sort {
-       irms_auxiliary        = 0, /**< Only for Firm use. Not extensible. (irm_T) */
-       irms_control_flow     = 1, /**< Marks all control flow modes. Not extensible. (irm_BB, irm_X) */
-       irms_memory           = 2 | irmsh_is_dataM, /**< Marks the memory mode.  Not extensible. (irm_M) */
-
-       /** Internal boolean representation.
-            Storing to memory impossible, convert first. (irm_b) */
-       irms_internal_boolean = 3 | irmsh_is_datab,
-
-       /** A mode to represent entities.
-           Restricted int computations can be performed */
-       irms_reference        = 4 | irmsh_is_data | irmsh_is_datab | irmsh_is_dataM,
-       /** A mode to represent int numbers.
-           Integer computations can be performed. */
-       irms_int_number       = 5 | irmsh_is_data | irmsh_is_datab | irmsh_is_dataM | irmsh_is_num,
-       /** A mode to represent float numbers.
-           Floating point computations can be performed. */
-       irms_float_number     = 6 | irmsh_is_data | irmsh_is_datab | irmsh_is_dataM | irmsh_is_num,
-} ir_mode_sort;
-
 /**
  * These values represent the different arithmetic operations possible with a
  * mode.
@@ -83,25 +49,13 @@ typedef enum ir_mode_arithmetic {
        irma_twos_complement = 2, /**< Values of the mode are represented as two's
                                       complement. Only legal for modes of sort
                                       int_number and reference. */
-       irma_ones_complement,     /**< Values of the mode are represented  as one's
-                                      complement. Only legal for modes of sort
-                                      int_number and reference. */
-       irma_int_BCD,             /**< Values of the mode are represented as binary
-                                      coded decimals. Only legal for modes of sort
-                                      int_number and reference. */
        irma_ieee754 = 256,       /**< Values of the mode are represented according
                                       to ieee754 floating point standard.  Only
                                       legal for modes of sort float_number. */
-       irma_float_BCD,           /**< Values of the mode are represented as binary
-                                      coded decimals according to @@@ which
-                                      standards??? Only legal for modes of sort
-                                      float_number. */
-       irma_max
+       irma_x86_extended_float,  /**< x86 extended floatingpoint values */
+       irma_last = irma_x86_extended_float,
 } ir_mode_arithmetic;
 
-/** Returns the name of the arithmetic type. */
-FIRM_API const char *get_mode_arithmetic_name(ir_mode_arithmetic ari);
-
 /**
  * Creates a new mode.
  *
@@ -115,46 +69,38 @@ FIRM_API const char *get_mode_arithmetic_name(ir_mode_arithmetic ari);
  * This function constructs a new mode given by the parameters.
  * If the parameters match an already defined mode, this mode is returned
  * (including the default modes).
- * If the mode is newly allocated, a new unique mode_code is chosen.
- * Also, special value tarvals will be calculated such as null,
- * min, max and can be retrieved using the get_mode_* functions
  *
  * @return
  *   The new mode or NULL on error.
+ */
+FIRM_API ir_mode *new_int_mode(const char *name,
+                               ir_mode_arithmetic arithmetic,
+                               unsigned bit_size, int sign,
+                               unsigned modulo_shift);
+
+/**
+ * Create a new reference mode.
  *
- * @note
- *   It is allowed to construct the default modes. So, a call
- *   new_ir_mode("Is", irms_int_number, 32, 1, irma_twos_complement, 32) will
- *   return mode_Is.
+ * Reference modes are always unsigned.
  */
-FIRM_API ir_mode *new_ir_mode(const char *name, ir_mode_sort sort, int bit_size,
-                              int sign, ir_mode_arithmetic arithmetic,
-                              unsigned int modulo_shift);
+FIRM_API ir_mode *new_reference_mode(const char *name,
+                                     ir_mode_arithmetic arithmetic,
+                                     unsigned bit_size,
+                                     unsigned modulo_shift);
 
 /**
- * Creates a new vector mode.
+ * Create a new ieee754 float mode.
  *
+ * float-modes are always signed and have no modulo shift.
  * @param name          the name of the mode to be created
- * @param sort          the ir_mode_sort of the mode to be created
- * @param bit_size      number of bits for one element of this mode
- * @param num_of_elem   number of elements in this vector mode
- * @param sign          non-zero if this is a signed mode
- * @param arithmetic    arithmetic operations possible with a mode
- * @param modulo_shift  Is ignored for modes other than integer.
- *
- * This function constructs a new vector mode given by the parameters.
- * If the parameters match an already defined mode, this mode is returned.
- * If the mode is newly allocated, a new unique mode_code is chosen.
- * Also, special value tarvals will be calculated such as null,
- * min, max and can be retrieved using the get_mode_* functions
- *
- * @return
- *   The new mode or NULL on error.
+ * @param arithmetic    arithmetic/representation of the mode
+ * @param exponent_size size of exponent in bits
+ * @param mantissa_size size of mantissa in bits
  */
-FIRM_API ir_mode *new_ir_vector_mode(const char *name, ir_mode_sort sort,
-                                     int bit_size, unsigned num_of_elem,
-                                     int sign, ir_mode_arithmetic arithmetic,
-                                     unsigned int modulo_shift);
+FIRM_API ir_mode *new_float_mode(const char *name,
+                                 ir_mode_arithmetic arithmetic,
+                                 unsigned exponent_size,
+                                 unsigned mantissa_size);
 
 /**
  * Checks whether a pointer points to a mode.
@@ -172,9 +118,6 @@ FIRM_API ident *get_mode_ident(const ir_mode *mode);
 /** Returns the null-terminated name of this mode. */
 FIRM_API const char *get_mode_name(const ir_mode *mode);
 
-/** Returns a coarse classification of the mode. */
-FIRM_API ir_mode_sort get_mode_sort(const ir_mode *mode);
-
 /** Returns the size of values of the mode in bits. */
 FIRM_API unsigned get_mode_size_bits(const ir_mode *mode);
 
@@ -198,14 +141,6 @@ FIRM_API ir_mode_arithmetic get_mode_arithmetic(const ir_mode *mode);
  */
 FIRM_API unsigned int get_mode_modulo_shift(const ir_mode *mode);
 
-/** Return the number of vector elements.
- *
- *  Attribute vector_elem specifies the number of vector elements of
- *  a vector mode. For non-vector modes it returns 1 for data and 0
- *  for all other modes
- */
-FIRM_API unsigned int get_mode_n_vector_elems(const ir_mode *mode);
-
 /** Returns the stored intermediate information. */
 FIRM_API void *get_mode_link(const ir_mode *mode);
 
@@ -280,9 +215,9 @@ FIRM_API ir_tarval *get_mode_NAN(ir_mode *mode);
 
 FIRM_API ir_mode *mode_M; /**< memory */
 
-FIRM_API ir_mode *mode_F;   /**< float (32) */
-FIRM_API ir_mode *mode_D;   /**< double (64) */
-FIRM_API ir_mode *mode_E;   /**< long double (80/128/...) */
+FIRM_API ir_mode *mode_F;   /**< ieee754 binary32 float (single precision) */
+FIRM_API ir_mode *mode_D;   /**< ieee754 binary64 float (double precision) */
+FIRM_API ir_mode *mode_Q;   /**< ieee754 binary128 float (quadruple precision)*/
 FIRM_API ir_mode *mode_Bs;  /**< int8 */
 FIRM_API ir_mode *mode_Bu;  /**< uint8 */
 FIRM_API ir_mode *mode_Hs;  /**< int16 */
@@ -313,7 +248,7 @@ FIRM_API ir_mode *mode_BAD;/**< bad mode */
 
 FIRM_API ir_mode *get_modeF(void);
 FIRM_API ir_mode *get_modeD(void);
-FIRM_API ir_mode *get_modeE(void);
+FIRM_API ir_mode *get_modeQ(void);
 FIRM_API ir_mode *get_modeBs(void);
 FIRM_API ir_mode *get_modeBu(void);
 FIRM_API ir_mode *get_modeHs(void);
@@ -378,8 +313,6 @@ FIRM_API void set_modeP_data(ir_mode *p);
 
    The set of "dataM" is defined as:
    dataM =  {data || irm_M}
-
-   Vector "int" and "float" are defined by the arithmetic and vector_elem > 1.
 */
 
 FIRM_API int mode_is_signed (const ir_mode *mode);
@@ -390,8 +323,6 @@ FIRM_API int mode_is_num (const ir_mode *mode);
 FIRM_API int mode_is_data (const ir_mode *mode);
 FIRM_API int mode_is_datab (const ir_mode *mode);
 FIRM_API int mode_is_dataM (const ir_mode *mode);
-FIRM_API int mode_is_float_vector (const ir_mode *mode);
-FIRM_API int mode_is_int_vector (const ir_mode *mode);
 /*@}*/
 
 /**
@@ -471,6 +402,16 @@ FIRM_API ir_mode *get_reference_mode_unsigned_eq(ir_mode *mode);
  */
 FIRM_API void set_reference_mode_unsigned_eq(ir_mode *ref_mode, ir_mode *int_mode);
 
+/**
+ * Return size of mantissa in bits (for float modes)
+ */
+FIRM_API unsigned get_mode_mantissa_size(const ir_mode *mode);
+
+/**
+ * Return size of exponent in bits (for float modes)
+ */
+FIRM_API unsigned get_mode_exponent_size(const ir_mode *mode);
+
 /**
  * Returns non-zero if the cast from mode src to mode dst is a
  * reinterpret cast (ie. only the bit pattern is reinterpreted,