* @brief Data modes of operations.
* @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Mathias Heil,
* Michael Beck
- * @brief
+ */
+#ifndef FIRM_IR_IRMODE_H
+#define FIRM_IR_IRMODE_H
+
+#include "firm_types.h"
+#include "begin.h"
+
+#include <stddef.h>
+
+/**
+ * @defgroup ir_mode Value Modes
* This module specifies the modes that type the firm nodes. It defines
* a datasturcture that describes a mode and implements constructors and
* access routines to this datastructure. Further it defines a set of
*
* SEE ALSO:
* UKA tech report 1999-44 for more information about modes.
+ * @{
*/
-#ifndef FIRM_IR_IRMODE_H
-#define FIRM_IR_IRMODE_H
-
-#include "firm_types.h"
-#include "begin.h"
/**
* These values represent the different arithmetic operations possible with a
* mode.
*/
typedef enum ir_mode_arithmetic {
- irma_uninitialized = 0,
irma_none = 1, /**< For modes for which no representation is
specified. These are modes of sort auxiliary,
internal_boolean and character. */
* Creates a new mode.
*
* @param name the name of the mode to be created
- * @param sort the ir_mode_sort of the mode to be created
+ * @param arithmetic arithmetic operations possible with a mode
* @param bit_size number of bits this mode allocate
* @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.
* @param name the name of the mode to be created
* @param arithmetic arithmetic/representation of the mode
* @param exponent_size size of exponent in bits
- * @param mantissa_size size of mantissa in bits
+ * @param mantissa_size size of mantissa in bits (number of bits after the
+ * leading one).
*/
FIRM_API ir_mode *new_float_mode(const char *name,
ir_mode_arithmetic arithmetic,
/** Returns the arithmetic of a mode */
FIRM_API ir_mode_arithmetic get_mode_arithmetic(const ir_mode *mode);
-/** Get the modulo shift attribute.
+/** Returns 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
FIRM_API ir_mode *mode_ANY;/**< undefined mode */
FIRM_API ir_mode *mode_BAD;/**< bad mode */
+/** Returns float mode */
FIRM_API ir_mode *get_modeF(void);
+/** Returns double mode */
FIRM_API ir_mode *get_modeD(void);
+/** Returns quadruple prevision mode */
FIRM_API ir_mode *get_modeQ(void);
+/** Returns byte signed mode */
FIRM_API ir_mode *get_modeBs(void);
+/** Returns byte unsigned mode */
FIRM_API ir_mode *get_modeBu(void);
+/** Returns halfword signed mode */
FIRM_API ir_mode *get_modeHs(void);
+/** Returns halfword unsigned mode */
FIRM_API ir_mode *get_modeHu(void);
+/** Returns integer signed mode */
FIRM_API ir_mode *get_modeIs(void);
+/** Returns integer unsigned mode */
FIRM_API ir_mode *get_modeIu(void);
+/** Returns long signed mode */
FIRM_API ir_mode *get_modeLs(void);
+/** Returns long unsigned mode */
FIRM_API ir_mode *get_modeLu(void);
+/** Returns long long signed mode */
FIRM_API ir_mode *get_modeLLs(void);
+/** Returns long long unsigned mode */
FIRM_API ir_mode *get_modeLLu(void);
+/** Returns pointer mode */
FIRM_API ir_mode *get_modeP(void);
+/** Returns internal boolean mode */
FIRM_API ir_mode *get_modeb(void);
+/** Returns control-flow mode */
FIRM_API ir_mode *get_modeX(void);
+/** Returns Basic-Block mode */
FIRM_API ir_mode *get_modeBB(void);
+/** Returns memory mode */
FIRM_API ir_mode *get_modeM(void);
+/** Returns tuple mode */
FIRM_API ir_mode *get_modeT(void);
+/** Returns ANY mode */
FIRM_API ir_mode *get_modeANY(void);
+/** Returns BAD mode */
FIRM_API ir_mode *get_modeBAD(void);
/** Returns the machine specific pointer mode for code addresses. */
*/
FIRM_API void set_modeP_data(ir_mode *p);
-/*@{
- Functions to check, whether a mode is signed, float, int, character,
- reference, num, data, datab or dataM.
-
- For more exact definitions read the corresponding pages
- in the firm documentation or the following enumeration
-
- The set of "float" is defined as:
- float = {irm_F, irm_D, irm_E}
-
- The set of "int" is defined as:
- int = {irm_Bs, irm_Bu, irm_Hs, irm_Hu, irm_Is, irm_Iu, irm_Ls, irm_Lu}
-
- The set of "reference" is defined as:
- reference = {irm_P}
-
- The set of "num" is defined as:
- num = {float || int}
-
- The set of "data" is defined as:
- data = {num || reference}
-
- The set of "datab" is defined as:
- datab = {data || irm_b }
-
- The set of "dataM" is defined as:
- dataM = {data || irm_M}
-*/
-
+/** Returns 1 if @p mode is signed, 0 otherwise */
FIRM_API int mode_is_signed (const ir_mode *mode);
+/** Returns 1 if @p mode is for floatingpoint numbers, 0 otherwise */
FIRM_API int mode_is_float (const ir_mode *mode);
+/** Returns 1 if @p mode is for integer numbers, 0 otherwise */
FIRM_API int mode_is_int (const ir_mode *mode);
+/** Returns 1 if @p mode is for references/pointers, 0 otherwise */
FIRM_API int mode_is_reference (const ir_mode *mode);
+/** Returns 1 if @p mode is for numeric values, 0 otherwise */
FIRM_API int mode_is_num (const ir_mode *mode);
+/** Returns 1 if @p mode is for data values, 0 otherwise */
FIRM_API int mode_is_data (const ir_mode *mode);
+/** Returns 1 if @p mode is for data values or internal booleans, 0 otherwise */
FIRM_API int mode_is_datab (const ir_mode *mode);
+/** Returns 1 if @p mode is for data values or memory, 0 otherwise */
FIRM_API int mode_is_dataM (const ir_mode *mode);
-/*@}*/
/**
- * Returns true if sm can be converted to lm without loss
- * according to firm definition.
+ * Returns true if a value of mode @p sm can be converted to mode @p lm without
+ * loss.
*
- * Note that mode_Iu is NOT smaller than mode_Is here.
+ * That is the interpretation of the numbers does not changes, so you a signed
+ * integer mode is never smaller than an unsigned integer mode since the
+ * unsigned mode can't represent negative numbers in a way that they are
+ * interpreted as negative numbers.
*
* @see values_in_mode()
*/
FIRM_API int smaller_mode(const ir_mode *sm, const ir_mode *lm);
/**
- * Returns true if a value of mode sm can be converted into mode lm
- * and backwards without loss.
+ * Returns true if no information is lost when converting a value of mode @p sm
+ * into mode @p lm (and back to mode @p sm).
*
- * Note that mode_Iu values CAN be converted in mode_Is and back.
+ * So the interpretation of the values may change in the intermediate mode @p sm
+ * (for example when converting negative signed integer numbers into unsigned
+ * integers) but after a conversion back they are exactly the same value.
*
* @see smaller_mode()
*/
FIRM_API int mode_wrap_around(const ir_mode *mode);
/**
- * Return the signed integer equivalent mode for an reference mode.
+ * Returns the signed integer equivalent mode for an reference mode.
*/
FIRM_API ir_mode *get_reference_mode_signed_eq(ir_mode *mode);
FIRM_API void set_reference_mode_signed_eq(ir_mode *ref_mode, ir_mode *int_mode);
/**
- * Return the unsigned integer equivalent mode for an reference mode.
+ * Returns the unsigned integer equivalent mode for an reference mode.
*/
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)
+ * Returns size of mantissa in bits (for float modes).
+ * Note: This is the number of bits used after the leading one. So the actual
+ * accuracy of the significand is get_mode_mantissa_size()+1. The number of bits
+ * used in the encoding depends on wether the floatingpoint mode has an implicit
+ * (ieee754) or explicit (x86_extended) encoding of the leading one.
*/
FIRM_API unsigned get_mode_mantissa_size(const ir_mode *mode);
/**
- * Return size of exponent in bits (for float modes)
+ * Returns size of exponent in bits (for float modes)
*/
FIRM_API unsigned get_mode_exponent_size(const ir_mode *mode);
*/
FIRM_API ir_type *get_type_for_mode(const ir_mode *mode);
+/** Returns number of known modes. */
+FIRM_API size_t ir_get_n_modes(void);
+
+/** Returns known mode number @p num. */
+FIRM_API ir_mode *ir_get_mode(size_t num);
+
+/** @} */
+
#include "end.h"
#endif
projects / libfirm / blobdiff