* @date 2003
* @author Mathias Heil
* @version $Id$
- * @summary
+ * @brief
* Tarvals represent target machine values. They are typed by modes.
* Tarvals only represent values of mode_sort:
* - int_number,
* - 0[0-7]* (octal representation)
* - (+|-)?[1-9][0-9]* (decimal representation)
*
- * if mode if float_number:
+ * if mode is float_number:
* - (+|-)?(decimal int) (. (decimal int))? ((e|E)(+|-)?(decimal int))?
*
* if mode is boolean: true, True, TRUE ... False... 0, 1,
*/
int tarval_is_minus_one(tarval *tv);
-/*
+/**
* returns non-zero if all bits in the tarval are set
*/
int tarval_is_all_one(tarval *tv);
+/**
+ * Return non-zero if the tarval is a constant (ie. NOT
+ * a reserved tarval like bad, undef, reachable etc.)
+ */
+int tarval_is_constant(tarval *tv);
+
/** The 'bad' tarval. */
extern tarval *tarval_bad;
-/** Returns the 'bad tarval. */
+/** Returns the 'bad' tarval. */
tarval *get_tarval_bad(void);
/** The 'undefined' tarval. */
/** The mode_b tarval 'false'. */
extern tarval *tarval_b_false;
-
/** Returns the mode_b tarval 'false'. */
tarval *get_tarval_b_false(void);
/** Returns the mode_b tarval 'true'. */
tarval *get_tarval_b_true(void);
+/** The mode_X tarval 'unreachable'. */
+extern tarval *tarval_unreachable;
+/** Returns the mode_X tarval 'unreachable'. */
+tarval *get_tarval_unreachable(void);
+
+/** The mode_X tarval 'reachable'. */
+extern tarval *tarval_reachable;
+/** Returns the mode_X tarval 'reachable'. */
+tarval *get_tarval_reachable(void);
+
+/** The 'top' tarval. This is just another name for the 'undefined' tarval. */
+#define tarval_top tarval_undefined
+/** Returns the 'top' tarval. */
+#define get_tarval_top() get_tarval_undefined()
+
+/** The 'bottom' tarval. This is just another name for the 'bad' tarval. */
+#define tarval_bottom tarval_bad
+/** Returns the 'bottom' tarval. */
+#define get_tarval_bottom() get_tarval_bad()
+
/* These functions calculate and return a tarval representing the requested
* value.
* The functions get_mode_{Max,Min,...} return tarvals retrieved from these
/**
* Sets the overflow mode for integer operations.
+ *
+ * @param ov_mode one of teh overflow modes
*/
void tarval_set_integer_overflow_mode(tarval_int_overflow_mode_t ov_mode);
* The sort member of the struct mode defines which operations are valid
*/
-/** Bitwise Negation of a tarval. */
+/**
+ * Bitwise Negation of a tarval.
+ *
+ * @param a the first tarval
+ *
+ * @return ~a or tarval_bad
+ */
tarval *tarval_not(tarval *a);
-/** Arithmetic Negation of a tarval. */
+/**
+ * Arithmetic Negation of a tarval.
+ *
+ * @param a the first tarval
+ *
+ * @return -a or tarval_bad
+ */
tarval *tarval_neg(tarval *a);
-/** Addition of two tarvals. */
+/**
+ * Addition of two tarvals.
+ *
+ * @param a the first tarval
+ * @param b the second tarval
+ *
+ * @return a + b or tarval_bad
+ */
tarval *tarval_add(tarval *a, tarval *b);
-/** Subtraction from a tarval. */
-tarval *tarval_sub(tarval *a, tarval *b);
+/**
+ * Subtraction from a tarval.
+ *
+ * @param a the first tarval
+ * @param b the second tarval
+ * @param dst_mode the mode of the result, needed for mode_P - mode_P, else NULL
+ *
+ * @return a - b or tarval_bad
+ */
+tarval *tarval_sub(tarval *a, tarval *b, ir_mode *dst_mode);
-/** Multiplication of tarvals. */
+/**
+ * Multiplication of tarvals.
+ *
+ * @param a the first tarval
+ * @param b the second tarval
+ *
+ * @return a * b or tarval_bad
+ */
tarval *tarval_mul(tarval *a, tarval *b);
-/** 'Exact' division of two tarvals. */
+/**
+ * Division of two floating point tarvals.
+ *
+ * @param a the first tarval
+ * @param b the second tarval
+ *
+ * @return a / b or tarval_bad
+ */
tarval *tarval_quo(tarval *a, tarval *b);
-/** Integer division of two tarvals. */
+/**
+ * Integer division of two tarvals.
+ *
+ * @param a the first tarval
+ * @param b the second tarval
+ *
+ * @return a / b or tarval_bad
+ */
tarval *tarval_div(tarval *a, tarval *b);
-/** Remainder of integer division. */
+/**
+ * Remainder of integer division.
+ *
+ * @param a the first tarval
+ * @param b the second tarval
+ *
+ * @return a % b or tarval_bad
+ */
tarval *tarval_mod(tarval *a, tarval *b);
-/** Integer division AND remainder. */
+/**
+ * Integer division AND remainder.
+ *
+ * @param a the first tarval
+ * @param b the second tarval
+ * @param mod_res after return, contains the remainder result, a % b or tarval_bad
+ *
+ * @return a / b or tarval_bad
+ */
tarval *tarval_divmod(tarval *a, tarval *b, tarval **mod_res);
-/** Absolute value of a tarval. */
+/**
+ * Absolute value of a tarval.
+ *
+ * @param a the first tarval
+ *
+ * @return |a| or tarval_bad
+ */
tarval *tarval_abs(tarval *a);
-/** Bitwise and. */
+/**
+ * Bitwise and of two integer tarvals.
+ *
+ * @param a the first tarval
+ * @param b the second tarval
+ *
+ * @return a & b or tarval_bad
+ */
tarval *tarval_and(tarval *a, tarval *b);
-/** Bitwise or. */
+/**
+ * Bitwise or of two integer tarvals.
+ *
+ * @param a the first tarval
+ * @param b the second tarval
+ *
+ * @return a | b or tarval_bad
+ */
tarval *tarval_or(tarval *a, tarval *b);
-/** Bitwise exclusive or. */
+/**
+ * Bitwise exclusive or of two integer tarvals.
+ *
+ * @param a the first tarval
+ * @param b the second tarval
+ *
+ * @return a ^ b or tarval_bad
+ */
tarval *tarval_eor(tarval *a, tarval *b);
-/** Left shift. */
+/**
+ * Logical Left shift.
+ *
+ * @param a the first tarval
+ * @param b the second tarval
+ *
+ * @return a << b or tarval_bad
+ */
tarval *tarval_shl(tarval *a, tarval *b);
-/** Unsigned (logical) right shift. */
+/**
+ * Unsigned (logical) right shift.
+ *
+ * @param a the first tarval
+ * @param b the second tarval
+ *
+ * @return a >>u b or tarval_bad
+ */
tarval *tarval_shr(tarval *a, tarval *b);
-/** Signed (arithmetic) right shift. */
+/**
+ * Signed (arithmetic) right shift.
+ *
+ * @param a the first tarval
+ * @param b the second tarval
+ *
+ * @return a >>s b or tarval_bad
+ */
tarval *tarval_shrs(tarval *a, tarval *b);
-/** Rotation to left. */
+/**
+ * Rotation to left.
+ *
+ * @param a the first tarval
+ * @param b the second tarval
+ *
+ * @return a \<\<L\>\> b or tarval_bad
+ */
tarval *tarval_rotl(tarval *a, tarval *b);
/**
* precision loss.
*
* @param tv the tarval
- * param mode the mode to convert to
+ * @param mode the mode to convert to
*/
int tarval_ieee754_can_conv_lossless(tarval *tv, ir_mode *mode);
*/
unsigned tarval_ieee754_get_exact(void);
+/**
+ * Return the size of the mantissa in bits (including possible
+ * implicit bits) for the given mode.
+ */
+unsigned tarval_ieee754_get_mantissa_size(const ir_mode *mode);
+
/**
* Enable/Disable floating point constant folding.
*/
-int tarval_enable_fp_ops(int enable);
+void tarval_enable_fp_ops(int enable);
+
+/** returns 0/1 if floating point folding is enable/disabled */
+int tarval_fp_ops_enabled(void);
/**
* Check if its the a floating point NaN.
*/
int tarval_is_finite(tarval *tv);
+/**
+ * Checks whether a pointer points to a tarval.
+ *
+ * @param thing an arbitrary pointer
+ *
+ * @return
+ * true if the thing is a tarval, else false
+ */
+int is_tarval(const void *thing);
+
#endif /* FIRM_TV_TV_H */
projects / libfirm / blobdiff