removed INLIEN before global functions
[libfirm] / ir / ir / irmode.h
index 6990b47..6ec83aa 100644 (file)
  *  -  ident *name:             Name of this mode. Two modes are different if the name is different.
  *  -  mode_sort sort:          sort of mode specifying possible usage kategories
  *  -  int    size:             size of the mode in Bits.
- *  -  int    align:            byte alignment
  *  -  unsigned sign:1:         signedness of this mode
  *  -  ... more to come
+ *  -  modulo_shift             specifies for modes of kind irms_int_number
+ *                              whether shift applies modulo to value of bits to shift
  *
  * SEE ALSO:
  *    The tech report 1999-44 describing FIRM and predefined modes
@@ -93,8 +94,8 @@ typedef enum { /* irm is short for `ir mode' */
 typedef enum {
   /* Predefined sorts of modes */
   irms_auxiliary,         /**< Only for Firm use. Not extensible. (irm_T) */
-  irms_control_flow,       /**< Marks all control flow modes. Not extensible. (irm_BB, irm_X) */
-  irms_memory,             /**< Marks the memory mode.  Not extensible. (irm_M) */
+  irms_control_flow,      /**< Marks all control flow modes. Not extensible. (irm_BB, irm_X) */
+  irms_memory,            /**< Marks the memory mode.  Not extensible. (irm_M) */
   irms_internal_boolean,  /**< Internal boolean representation.
                               Storing to memory impossible, convert first. (irm_b) */
                             /** user-extensible sorts of modes **/
@@ -125,7 +126,7 @@ typedef enum {
   irma_ieee754 = 256,         /**< Values of the mode are represented according to ieee754
                                   floatingpoint 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 standars??? Only legal for modes of
+                                  according to @@@ which standards??? Only legal for modes of
                                   sort float_number. */
   irma_max
 } mode_arithmetic;
@@ -138,9 +139,9 @@ typedef enum {
  * @param name         the name of the mode to be created
  * @param sort         the mode_sort of the mode to be created
  * @param bit_size     number of bits this mode allocate
- * @param align                the byte alignment for an entity of this mode (in bits)
  * @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 mode given by the parameters.
  * If the parameters match an already defined mode, this mode is returned
@@ -154,9 +155,32 @@ typedef enum {
  *
  * @note
  *     It is allowed to construct the default modes. So, a call
- *     new_ir_mode("Is", irms_int_number, 32, 4, 1) will return mode_Is.
+ *     new_ir_mode("Is", irms_int_number, 32, 1, irma_twos_complement, 32) will return mode_Is.
  */
-ir_mode *new_ir_mode(const char *name, mode_sort sort, int bit_size, int align, int sign, mode_arithmetic arithmetic);
+ir_mode *new_ir_mode(const char *name, mode_sort sort, int bit_size, int sign, mode_arithmetic arithmetic, unsigned int modulo_shift);
+
+/**
+ * Creates a new vector mode.
+ *
+ * @param name         the name of the mode to be created
+ * @param sort         the 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 choosen.
+ * Also, special value tarvals will be calculated such as null,
+ * min, max and can be retrieved using the get_mode_* fuctions
+ *
+ * @return
+ *     The new mode or NULL on error.
+ */
+ir_mode *new_ir_vector_mode(const char *name, mode_sort sort, int bit_size, unsigned num_of_elem, int sign,
+                    mode_arithmetic arithmetic, unsigned int modulo_shift );
 
 /**
  *   Checks whether a pointer points to a mode.
@@ -166,43 +190,58 @@ ir_mode *new_ir_mode(const char *name, mode_sort sort, int bit_size, int align,
  *   @return
  *       true if the thing is a mode, else false
  */
-int is_mode (void *thing);
+int is_mode(void *thing);
 
 /* ********** Access methods to read mode information *********** */
 
 /** Returns the classification of the mode */
-modecode get_mode_modecode(const ir_mode *mode);
+modecode    get_mode_modecode(const ir_mode *mode);
 
 /** Returns the ident* of the mode */
-ident *get_mode_ident(const ir_mode *mode);
+ident      *get_mode_ident(const ir_mode *mode);
 
 /** Returns the null-terminated name of this mode. */
 const char *get_mode_name(const ir_mode *mode);
 
 /** Returns a coarse classification of the mode. */
-mode_sort get_mode_sort(const ir_mode *mode);
+mode_sort   get_mode_sort(const ir_mode *mode);
 
 /** Returns the size of values of the mode in bits. */
 int get_mode_size_bits(const ir_mode *mode);
 
-/** Returns the size of values of the mode in bytes.  If the size is not
   dividable by 8 returns -1. */
+/** Returns the size of values of the mode in bytes.
*  If the size is not dividable by 8 returns -1. */
 int get_mode_size_bytes(const ir_mode *mode);
 
-/** Returns the alignment of values of the mode in bytes. */
-int get_mode_align(const ir_mode *mode);
-
-/** Returns the signess of a mode */
-int get_mode_sign (const ir_mode *mode);
+/** Returns the signess of a mode.
+ *
+ * Returns the signess of a mode: 1 if mode is signed. */
+int get_mode_sign(const ir_mode *mode);
 
 /** Returns the arithmetic of a mode */
-int get_mode_arithmetic (const ir_mode *mode);
+int get_mode_arithmetic(const ir_mode *mode);
+
+/** Get the modulo shift attribute.
+ *
+ *  Attribute modulo shift specifies for modes of kind irms_int_number
+ *  whether shift applies modulo to value of bits to shift.  Zero for
+ *  modes that are not integer.
+ */
+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
+ */
+unsigned int get_mode_n_vector_elems(const ir_mode *mode);
 
 /** Returns the stored intermediate information. */
-voidget_mode_link(const ir_mode *mode);
+void *get_mode_link(const ir_mode *mode);
 
 /** Stores new intermediate information. */
-void set_mode_link(ir_mode *mode, void *l);
+void  set_mode_link(ir_mode *mode, void *l);
 
 /**
  * Returns the smallest representable value of a given mode.
@@ -225,7 +264,7 @@ tarval *get_mode_max(ir_mode *mode);
  *
  * Zero is the additive neutral element and as such
  * is defined only for modes allowing addition, i.e.
- * floats and ints, and references (NULL-Pointer)
+ * op_pin_state_floats and ints, and references (NULL-Pointer)
  * else returns tarval_bad.
  */
 tarval *get_mode_null(ir_mode *mode);
@@ -235,7 +274,7 @@ tarval *get_mode_null(ir_mode *mode);
  *
  * One, being the multiplicative neutral element,
  * is defined only for modes allowing multiplication,
- * i.e. ints and floats.
+ * i.e. ints and op_pin_state_floats.
  */
 tarval *get_mode_one(ir_mode *mode);
 
@@ -354,6 +393,8 @@ void set_modeP_mach(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.
 */
 /*@}*/
 /* Test for a certain class of modes. */
@@ -367,12 +408,29 @@ int mode_is_numP (const ir_mode *mode);
 int mode_is_data (const ir_mode *mode);
 int mode_is_datab (const ir_mode *mode);
 int mode_is_dataM (const ir_mode *mode);
+int mode_is_float_vector (const ir_mode *mode);
+int mode_is_int_vector (const ir_mode *mode);
 
 /** Returns true if sm can be converted to lm without loss
    according to firm definiton */
 int smaller_mode(const ir_mode *sm, const ir_mode *lm);
 
-/** mode module initialization, call once before use of any other function **/
-void init_mode (void);
+/**
+ * Returns a matching unsigned mode for a given integer signed mode.
+ * Returns NULL if no matching mode exists.
+ */
+ir_mode *find_unsigned_mode(const ir_mode *mode);
+
+/**
+ * Returns a matching signed mode for a given integer unsigned mode.
+ * Returns NULL if no matching mode exists.
+ */
+ir_mode *find_signed_mode(const ir_mode *mode);
+
+/**
+ * Returns an integer mode with 2*n bits for a given integer mode with n bits.
+ * Returns NULL if no matching mode exists.
+ */
+ir_mode *find_double_bits_int_mode(const ir_mode *mode);
 
 #endif /* _IRMODE_H_ */