* @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,
* @sa
* Techreport 1999-14
* irmode.h for the modes definitions
- * irnode.h for the pn_Cmp table
*/
#ifndef FIRM_TV_TV_H
#define FIRM_TV_TV_H
+#include <stddef.h>
#include "firm_types.h"
-#include "irnode.h"
+
+#include "begin.h"
/* ************************ Constructors for tarvals ************************ */
* - 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,
* new_tarval_from_long()
* new_tarval_from_double()
*/
-tarval *new_tarval_from_str(const char *str, size_t len, ir_mode *mode);
+FIRM_API ir_tarval *new_tarval_from_str(const char *str, size_t len,
+ ir_mode *mode);
+
+/**
+ * Construct a new tarval from a given string.
+ *
+ * @param str The string representing the target value
+ * @param len The length of the string
+ * @param sign is -1 or 1 depending on the numbers sign
+ * @param base number system base.
+ * binary(2), octal(8), decimal(10) and hexadecimal(16) numbers
+ * are supported.
+ * @param mode The mode requested for the result tarval
+ *
+ * @return
+ * A tarval with the given mode. If overflow settings are set to
+ * TV_OVERFLOW_BAD then a tarval_bad is returned if the number can't be
+ * represented in the given mode.
+ * Return bad if the number couldn't successfully be parsed.
+ */
+FIRM_API ir_tarval *new_integer_tarval_from_str(const char *str, size_t len,
+ char sign, unsigned char base,
+ ir_mode *mode);
/**
* Constructor function for new tarvals
* new_tarval_from_double()
*
*/
-tarval *new_tarval_from_long(long l, ir_mode *mode);
+FIRM_API ir_tarval *new_tarval_from_long(long l, ir_mode *mode);
/** Return value as long if possible.
*
* you are doing! (better check with tarval_is_long()...)
* Works only for int modes, even not for character modes!
*/
-long get_tarval_long(tarval *tv);
+FIRM_API long get_tarval_long(ir_tarval *tv);
/**
* This validates if get_tarval_long() will return a satisfying
*
* @param tv the tarval
*/
-int tarval_is_long(tarval *tv);
+FIRM_API int tarval_is_long(ir_tarval *tv);
/**
* Constructor function for new tarvals.
* new_tarval_from_str()
* new_tarval_from_long()
*/
-tarval *new_tarval_from_double(long double d, ir_mode *mode);
+FIRM_API ir_tarval *new_tarval_from_double(double d, ir_mode *mode);
+
+/**
+ * same as new_tarval_from_double(), but with a long double argument
+ */
+FIRM_API ir_tarval *new_tarval_from_long_double(long double d, ir_mode *mode);
/**
* This returns a double with the value represented value, or
*
* @param tv the tarval
*/
-long double get_tarval_double(tarval *tv);
+FIRM_API double get_tarval_double(ir_tarval *tv);
+
+/**
+ * same as get_tarval_double but returns a long double value
+ */
+FIRM_API long double get_tarval_long_double(ir_tarval *tv);
/**
* This validates if tarval_to_double() will return a satisfying
*
* @param tv the tarval
*/
-int tarval_is_double(tarval *tv);
+FIRM_API int tarval_is_double(ir_tarval *tv);
/** ********** Access routines for tarval fields ********** **/
*
* @param tv the tarval
*/
-ir_mode *get_tarval_mode(const tarval *tv);
-
-/** Returns the contents of the 'link' field of the tarval */
-/* void *get_tarval_link (tarval*); */
-
-/* Testing properties of the represented values */
+FIRM_API ir_mode *get_tarval_mode(const ir_tarval *tv);
/**
* Returns 1 if tv is negative
*
* @param tv the tarval
*/
-int tarval_is_negative(tarval *tv);
+FIRM_API int tarval_is_negative(ir_tarval *tv);
/**
* Returns 1 if tv is null
*
* @param tv the tarval
*/
-int tarval_is_null(tarval *tv);
+FIRM_API int tarval_is_null(ir_tarval *tv);
/**
* Returns 1 if tv is the "one"
*
* @param tv the tarval
*/
-int tarval_is_one(tarval *tv);
+FIRM_API int tarval_is_one(ir_tarval *tv);
/**
* Returns 1 if tv is the "minus one"
*
* @param tv the tarval
*/
-int tarval_is_minus_one(tarval *tv);
+FIRM_API int tarval_is_minus_one(ir_tarval *tv);
/**
* returns non-zero if all bits in the tarval are set
*/
-int tarval_is_all_one(tarval *tv);
+FIRM_API int tarval_is_all_one(ir_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);
+FIRM_API int tarval_is_constant(ir_tarval *tv);
/** The 'bad' tarval. */
-extern tarval *tarval_bad;
+FIRM_API ir_tarval *tarval_bad;
/** Returns the 'bad' tarval. */
-tarval *get_tarval_bad(void);
+FIRM_API ir_tarval *get_tarval_bad(void);
/** The 'undefined' tarval. */
-extern tarval *tarval_undefined;
+FIRM_API ir_tarval *tarval_undefined;
/** Returns the 'undefined' tarval. */
-tarval *get_tarval_undefined(void);
+FIRM_API ir_tarval *get_tarval_undefined(void);
/** The mode_b tarval 'false'. */
-extern tarval *tarval_b_false;
+FIRM_API ir_tarval *tarval_b_false;
/** Returns the mode_b tarval 'false'. */
-tarval *get_tarval_b_false(void);
+FIRM_API ir_tarval *get_tarval_b_false(void);
/** The mode_b tarval 'true'. */
-extern tarval *tarval_b_true;
+FIRM_API ir_tarval *tarval_b_true;
/** Returns the mode_b tarval 'true'. */
-tarval *get_tarval_b_true(void);
+FIRM_API ir_tarval *get_tarval_b_true(void);
/** The mode_X tarval 'unreachable'. */
-extern tarval *tarval_unreachable;
+FIRM_API ir_tarval *tarval_unreachable;
/** Returns the mode_X tarval 'unreachable'. */
-tarval *get_tarval_unreachable(void);
+FIRM_API ir_tarval *get_tarval_unreachable(void);
/** The mode_X tarval 'reachable'. */
-extern tarval *tarval_reachable;
+FIRM_API ir_tarval *tarval_reachable;
/** Returns the mode_X tarval 'reachable'. */
-tarval *get_tarval_reachable(void);
+FIRM_API ir_tarval *get_tarval_reachable(void);
/** The 'top' tarval. This is just another name for the 'undefined' tarval. */
#define tarval_top tarval_undefined
* therefore the irmode functions should be preferred to the functions below. */
/** Returns the maximum value of a given mode. */
-tarval *get_tarval_max(ir_mode *mode);
+FIRM_API ir_tarval *get_tarval_max(ir_mode *mode);
/** Returns the minimum value of a given mode. */
-tarval *get_tarval_min(ir_mode *mode);
+FIRM_API ir_tarval *get_tarval_min(ir_mode *mode);
/** Returns the 0 value (additive neutral) of a given mode.
For reference modes, the NULL value is returned (old tarval_P_void) */
-tarval *get_tarval_null(ir_mode *mode);
+FIRM_API ir_tarval *get_tarval_null(ir_mode *mode);
/** Returns the 1 value (multiplicative neutral) of a given mode. */
-tarval *get_tarval_one(ir_mode *mode);
+FIRM_API ir_tarval *get_tarval_one(ir_mode *mode);
/** Returns the -1 value (multiplicative neutral) of a given mode.
* Returns tarval bad for unsigned modes */
-tarval *get_tarval_minus_one(ir_mode *mode);
+FIRM_API ir_tarval *get_tarval_minus_one(ir_mode *mode);
/** returns the value where all bits are 1 of a given mode.
* returns tarval_bad for float modes */
-tarval *get_tarval_all_one(ir_mode *mode);
+FIRM_API ir_tarval *get_tarval_all_one(ir_mode *mode);
/** Return quite nan for float_number modes. */
-tarval *get_tarval_nan(ir_mode *mode);
+FIRM_API ir_tarval *get_tarval_nan(ir_mode *mode);
/** Return +inf for float_number modes. */
-tarval *get_tarval_plus_inf(ir_mode *mode);
+FIRM_API ir_tarval *get_tarval_plus_inf(ir_mode *mode);
/** Return -inf for float_number modes. */
-tarval *get_tarval_minus_inf(ir_mode *mode);
+FIRM_API ir_tarval *get_tarval_minus_inf(ir_mode *mode);
/* ******************** Arithmetic operations on tarvals ******************** */
-typedef enum _tarval_int_overflow_mode_t {
+typedef enum tarval_int_overflow_mode_t {
TV_OVERFLOW_BAD, /**< tarval module will return tarval_bad if a overflow occurs */
TV_OVERFLOW_WRAP, /**< tarval module will overflow will be ignored, wrap around occurs */
TV_OVERFLOW_SATURATE /**< tarval module will saturate the overflow */
/**
* 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);
+FIRM_API void tarval_set_integer_overflow_mode(tarval_int_overflow_mode_t ov_mode);
/**
* Get the overflow mode for integer operations.
*/
-tarval_int_overflow_mode_t tarval_get_integer_overflow_mode(void);
+FIRM_API tarval_int_overflow_mode_t tarval_get_integer_overflow_mode(void);
/**
* Compares two tarvals
*
- * Compare a with b and return a pn_Cmp describing the relation
- * between a and b. This is either pn_Cmp_Uo, pn_Cmp_Lt, pn_Cmp_Eq, pn_Cmp_Gt,
- * or pn_Cmp_False if a or b are symbolic pointers which can not be compared at all.
+ * Compare a with b and return their relation.
+ * This is either ir_rel_unordered, ir_rel_less, ir_rel_greater, ir_rel_equal
+ * or ir_rel_false if a or b are symbolic pointers which can not be compared at
+ * all.
*
* @param a the first tarval to be compared
* @param b the second tarval to be compared
- *
- * @return
- * The pn_Cmp best describing the relation between a and b is returned.
- * This means the mode with the least bits set is returned, e.g. if the
- * tarvals are equal the pn_Cmp 'pn_Cmp_Eq' is returned, not 'pn_Cmp_Ge' which
- * indicates 'greater or equal'
- *
- * @sa
- * irnode.h for the definition of pn_Cmp
*/
-pn_Cmp tarval_cmp(tarval *a, tarval *b);
+FIRM_API ir_relation tarval_cmp(ir_tarval *a, ir_tarval *b);
/**
* Converts a tarval to another mode.
* FIRM documentation for conversion rules
* mode_is_smaller defined in irmode.h
*/
-tarval *tarval_convert_to(tarval *src, ir_mode *mode);
+FIRM_API ir_tarval *tarval_convert_to(ir_tarval *src, ir_mode *mode);
/*
* These function implement basic computations representable as opcodes
* The sort member of the struct mode defines which operations are valid
*/
-/** Bitwise Negation of a tarval. */
-tarval *tarval_not(tarval *a);
+/**
+ * Bitwise Negation of a tarval.
+ *
+ * @param a the first tarval
+ *
+ * @return ~a or tarval_bad
+ */
+FIRM_API ir_tarval *tarval_not(ir_tarval *a);
-/** Arithmetic Negation of a tarval. */
-tarval *tarval_neg(tarval *a);
+/**
+ * Arithmetic Negation of a tarval.
+ *
+ * @param a the first tarval
+ *
+ * @return -a or tarval_bad
+ */
+FIRM_API ir_tarval *tarval_neg(ir_tarval *a);
-/** Addition of two tarvals. */
-tarval *tarval_add(tarval *a, tarval *b);
+/**
+ * Addition of two tarvals.
+ *
+ * @param a the first tarval
+ * @param b the second tarval
+ *
+ * @return a + b or tarval_bad
+ */
+FIRM_API ir_tarval *tarval_add(ir_tarval *a, ir_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
+ */
+FIRM_API ir_tarval *tarval_sub(ir_tarval *a, ir_tarval *b, ir_mode *dst_mode);
-/** Multiplication of tarvals. */
-tarval *tarval_mul(tarval *a, tarval *b);
+/**
+ * Multiplication of tarvals.
+ *
+ * @param a the first tarval
+ * @param b the second tarval
+ *
+ * @return a * b or tarval_bad
+ */
+FIRM_API ir_tarval *tarval_mul(ir_tarval *a, ir_tarval *b);
-/** 'Exact' division of two tarvals. */
-tarval *tarval_quo(tarval *a, tarval *b);
+/**
+ * Integer division of two tarvals.
+ *
+ * @param a the first tarval
+ * @param b the second tarval
+ *
+ * @return a / b or tarval_bad
+ */
+FIRM_API ir_tarval *tarval_div(ir_tarval *a, ir_tarval *b);
-/** Integer division of two tarvals. */
-tarval *tarval_div(tarval *a, tarval *b);
+/**
+ * Remainder of integer division.
+ *
+ * @param a the first tarval
+ * @param b the second tarval
+ *
+ * @return a % b or tarval_bad
+ */
+FIRM_API ir_tarval *tarval_mod(ir_tarval *a, ir_tarval *b);
-/** Remainder of integer division. */
-tarval *tarval_mod(tarval *a, tarval *b);
+/**
+ * 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
+ */
+FIRM_API ir_tarval *tarval_divmod(ir_tarval *a, ir_tarval *b, ir_tarval **mod_res);
-/** Integer division AND remainder. */
-tarval *tarval_divmod(tarval *a, tarval *b, tarval **mod_res);
+/**
+ * Absolute value of a tarval.
+ *
+ * @param a the first tarval
+ *
+ * @return |a| or tarval_bad
+ */
+FIRM_API ir_tarval *tarval_abs(ir_tarval *a);
-/** Absolute value of a tarval. */
-tarval *tarval_abs(tarval *a);
+/**
+ * Bitwise and of two integer tarvals.
+ *
+ * @param a the first tarval
+ * @param b the second tarval
+ *
+ * @return a & b or tarval_bad
+ */
+FIRM_API ir_tarval *tarval_and(ir_tarval *a, ir_tarval *b);
-/** Bitwise and. */
-tarval *tarval_and(tarval *a, tarval *b);
+/**
+ * Bitwise and not of two integer tarvals.
+ *
+ * @param a the first tarval
+ * @param b the second tarval
+ *
+ * @return a & ~b or tarval_bad
+ */
+FIRM_API ir_tarval *tarval_andnot(ir_tarval *a, ir_tarval *b);
-/** Bitwise or. */
-tarval *tarval_or(tarval *a, tarval *b);
+/**
+ * Bitwise or of two integer tarvals.
+ *
+ * @param a the first tarval
+ * @param b the second tarval
+ *
+ * @return a | b or tarval_bad
+ */
+FIRM_API ir_tarval *tarval_or(ir_tarval *a, ir_tarval *b);
-/** Bitwise exclusive or. */
-tarval *tarval_eor(tarval *a, tarval *b);
+/**
+ * Bitwise exclusive or of two integer tarvals.
+ *
+ * @param a the first tarval
+ * @param b the second tarval
+ *
+ * @return a ^ b or tarval_bad
+ */
+FIRM_API ir_tarval *tarval_eor(ir_tarval *a, ir_tarval *b);
-/** Left shift. */
-tarval *tarval_shl(tarval *a, tarval *b);
+/**
+ * Logical Left shift.
+ *
+ * @param a the first tarval
+ * @param b the second tarval
+ *
+ * @return a << b or tarval_bad
+ */
+FIRM_API ir_tarval *tarval_shl(ir_tarval *a, ir_tarval *b);
-/** Unsigned (logical) right shift. */
-tarval *tarval_shr(tarval *a, tarval *b);
+/**
+ * Unsigned (logical) right shift.
+ *
+ * @param a the first tarval
+ * @param b the second tarval
+ *
+ * @return a >>u b or tarval_bad
+ */
+FIRM_API ir_tarval *tarval_shr(ir_tarval *a, ir_tarval *b);
-/** Signed (arithmetic) right shift. */
-tarval *tarval_shrs(tarval *a, tarval *b);
+/**
+ * Signed (arithmetic) right shift.
+ *
+ * @param a the first tarval
+ * @param b the second tarval
+ *
+ * @return a >>s b or tarval_bad
+ */
+FIRM_API ir_tarval *tarval_shrs(ir_tarval *a, ir_tarval *b);
-/** Rotation to left. */
-tarval *tarval_rotl(tarval *a, tarval *b);
+/**
+ * Rotation to left.
+ *
+ * @param a the first tarval
+ * @param b the second tarval
+ *
+ * @return a \<\<L\>\> b or tarval_bad
+ */
+FIRM_API ir_tarval *tarval_rotl(ir_tarval *a, ir_tarval *b);
/**
* Returns the carry flag of the last operation.
*/
-int tarval_carry(void);
+FIRM_API int tarval_carry(void);
/* *********** Output of tarvals *********** */
*
* @return zero on success.
*/
-int set_tarval_mode_output_option(ir_mode *mode, const tarval_mode_info *modeinfo);
+FIRM_API int set_tarval_mode_output_option(ir_mode *mode,
+ const tarval_mode_info *modeinfo);
/**
* Returns the output options of one mode.
*
* @return the output option
*/
-const tarval_mode_info *get_tarval_mode_output_option(ir_mode *mode);
+FIRM_API const tarval_mode_info *get_tarval_mode_output_option(ir_mode *mode);
/**
* Returns Bit representation of a tarval value, as string of '0' and '1'
* irmode.h for the definition of the ir_mode struct
* the size member of aforementioned struct
*/
-char *get_tarval_bitpattern(tarval *tv);
+FIRM_API char *get_tarval_bitpattern(ir_tarval *tv);
/**
* Returns the bitpattern of the bytes_ofs byte.
*
* To query a 32bit value the following code can be used:
*
- * val0 = tarval_sub_bits(tv, 0);
+ * val0 = tarval_sub_bits(tv, 0); <- lowest bits
* val1 = tarval_sub_bits(tv, 1);
* val2 = tarval_sub_bits(tv, 2);
- * val3 = tarval_sub_bits(tv, 3);
+ * val3 = tarval_sub_bits(tv, 3); <- highest bits
*
* Because this is the bit representation of the target machine, only the following
* operations are legal on the result:
* - bitwise logical operations to select/mask bits
*
* @param tv the tarval
- * @param byte_ofs the byte offset
+ * @param byte_ofs the byte offset from lower to higher
*
* @note
* The result of this function is undefined if the mode is neither integer nor float.
*/
-unsigned char get_tarval_sub_bits(tarval *tv, unsigned byte_ofs);
+FIRM_API unsigned char get_tarval_sub_bits(ir_tarval *tv, unsigned byte_ofs);
/**
* Returns non-zero if a given (integer) tarval has only one single bit
*
* @param tv the tarval
*/
-int tarval_is_single_bit(tarval *tv);
+FIRM_API int tarval_is_single_bit(ir_tarval *tv);
+
+/**
+ * Return the number of set bits in a given (integer) tarval.
+ *
+ * @param tv the tarval
+ *
+ * @return number of set bits or -1 on error
+ */
+FIRM_API int get_tarval_popcount(ir_tarval *tv);
+
+/**
+ * Return the number of the lowest set bit in a given (integer) tarval.
+ *
+ * @param tv the tarval
+ *
+ * @return number of lowest set bit or -1 on error
+ */
+FIRM_API int get_tarval_lowest_bit(ir_tarval *tv);
/**
* Output a tarval to a string buffer.
* @param buflen the length of the buffer
* @param tv the tarval
*/
-int tarval_snprintf(char *buf, size_t buflen, tarval *tv);
+FIRM_API int tarval_snprintf(char *buf, size_t buflen, ir_tarval *tv);
/**
* Output a tarval to stdio.
*
* @param tv the tarval
*/
-int tarval_printf(tarval *tv);
+FIRM_API int tarval_printf(ir_tarval *tv);
/**
* Returns non-zero if the mantissa of a floating point IEEE-754
*
* @param tv the tarval
*/
-int tarval_ieee754_zero_mantissa(tarval *tv);
+FIRM_API int tarval_ieee754_zero_mantissa(ir_tarval *tv);
/**
* Returns the exponent of a floating point IEEE-754
*
* @param tv the tarval
*/
-int tarval_ieee754_get_exponent(tarval *tv);
+FIRM_API int tarval_ieee754_get_exponent(ir_tarval *tv);
/**
* Check if the tarval can be converted to the given mode without
* 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);
+FIRM_API int tarval_ieee754_can_conv_lossless(ir_tarval *tv, ir_mode *mode);
/**
* Set the immediate precision for IEEE-754 results. Set this to
*
* @return the old setting
*/
-unsigned tarval_ieee754_set_immediate_precision(unsigned bits);
+FIRM_API unsigned tarval_ieee754_set_immediate_precision(unsigned bits);
/**
* Returns non-zero if the result of the last IEEE-754 operation was exact.
*/
-unsigned tarval_ieee754_get_exact(void);
+FIRM_API unsigned tarval_ieee754_get_exact(void);
+
+/**
+ * Return the size of the mantissa in bits (including possible
+ * implicit bits) for the given mode.
+ */
+FIRM_API unsigned tarval_ieee754_get_mantissa_size(const ir_mode *mode);
/**
* Enable/Disable floating point constant folding.
*/
-int tarval_enable_fp_ops(int enable);
+FIRM_API void tarval_enable_fp_ops(int enable);
+
+/** returns 0/1 if floating point folding is enable/disabled */
+FIRM_API int tarval_fp_ops_enabled(void);
/**
* Check if its the a floating point NaN.
*
* @param tv the tarval
*/
-int tarval_is_NaN(tarval *tv);
+FIRM_API int tarval_is_NaN(ir_tarval *tv);
/**
* Check if its the a floating point +inf.
*
* @param tv the tarval
*/
-int tarval_is_plus_inf(tarval *tv);
+FIRM_API int tarval_is_plus_inf(ir_tarval *tv);
/**
* Check if its the a floating point -inf.
*
* @param tv the tarval
*/
-int tarval_is_minus_inf(tarval *tv);
+FIRM_API int tarval_is_minus_inf(ir_tarval *tv);
/**
* Check if the tarval represents a finite value, ie neither NaN nor inf.
*
* @param tv the tarval
*/
-int tarval_is_finite(tarval *tv);
+FIRM_API int tarval_is_finite(ir_tarval *tv);
/**
* Checks whether a pointer points to a tarval.
* @return
* true if the thing is a tarval, else false
*/
-int is_tarval(const void *thing);
+FIRM_API int is_tarval(const void *thing);
+
+#include "end.h"
-#endif /* FIRM_TV_TV_H */
+#endif
projects / libfirm / blobdiff