X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=ir%2Ftv%2Ftv.h;h=e4224e97286ac6f4bbf2a62f71864094b464c68c;hb=f274dcf35aa0d3f4748387dbddfe50e8d7d44951;hp=321739bb82b6f4855fcf4c83ca039cfefacb1b70;hpb=4d2013dc57776f3d97a74801c3d29eed7ed76a82;p=libfirm diff --git a/ir/tv/tv.h b/ir/tv/tv.h index 321739bb8..e4224e972 100644 --- a/ir/tv/tv.h +++ b/ir/tv/tv.h @@ -1,52 +1,26 @@ +/* + * Project: libFIRM + * File name: ir/tv/tv.h + * Purpose: Representation of and static computations on target machine + * values. + * Author: Mathias Heil + * Modified by: + * Created: + * CVS-ID: $Id$ + * Copyright: (c) 2003 Universität Karlsruhe + * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE. + */ + /** * @file tv.h * * Declarations for Target Values. */ - -/* $Id$ */ - -/* -Discussion of new interface, proposals by Prof. Waite: -(email of 13.6.2001) -> 1. You say that you plan to replace the tv module. That replacement is -> absolutely essential for an ANSI C translator: Section 6.1.3.2 of the -> standard says that the representation of an integer_constant depends -> upon its value as well as any suffixes that are attached to it. The -> possible Firm modes for such a constant are i, I, l, and L. The -> current tv module provides only one integer conversion routine, and -> that requires conversion by the client. Since the type of the value -> argument is long, this may preclude the representation of an unsigned -> long constant. -> -> There is a similar problem with floating constants. Floating -> constants can be suffixed in C, and the mode depends upon the suffix. -> It can indicate that the constant is of type long double, which your -> current tv module is incapable of representing. -> -> Your tv module interface accepts two kinds of information: modes and -> values. Values obtained from the program text might be uninterpreted -> strings, strings interpreted as integers, and strings interpreted as -> reals. Values provided by the compiler are usually integers. Modes are -> always Firm modes. It seems to me that the tv module should provide -> tarval* constructors for three of the four kinds of values. Each of these -> constructors should have an ir_mode parameter and one or more parameters -> appropriate for the kind of value. As is currently the case, one -> constructor should be provided for both compiler-generated integers and -> source strings interpreted as integers. (This avoids problems of -> different conversion radices -- the client does the conversion.) For -> symmetry, the constructor for source strings interpreted as reals should -> accept a long double parameter and require the client to do the -> conversion. - -*/ - #ifndef _TV_H_ #define _TV_H_ -# include "irmode.h" -# include "entity.h" -# include "irnode.h" /* for pnc_number enum */ +#include "irmode.h" +#include "irnode.h" /****h* libfirm/tv * @@ -55,7 +29,6 @@ Discussion of new interface, proposals by Prof. Waite: * Internal representation for machine values. * * AUTHORS - * Christian von Roques * Matthias Heil * * DESCRIPTION @@ -85,7 +58,7 @@ Discussion of new interface, proposals by Prof. Waite: * SEE ALSO * Techreport 1999-14 * irmode.h for the modes definitions - * irnode.h for the pnc_numbers table + * irnode.h for the pn_Cmp table * * tarval_init1 and tarval_init2 for initialization of the * module @@ -98,159 +71,151 @@ Discussion of new interface, proposals by Prof. Waite: #endif /* ************************ Constructors for tarvals ************************ */ -/****f* tv/new_tarval_from_str + +/** + * Constructor function for new tarvals. * - * NAME - * new_tarval_from_str - * Constructor function for new tarvals. + * @param str The string representing the target value + * @param len The length of the string + * @param mode The mode requested for the result tarval * - * SYNOPSIS - * tarval *new_tarval_from_str(const char *s, size_t len, ir_mode *mode) + * This function creates a new tarval representing the value represented + * by a CString, aka char array. If a tarval representing this value already + * exists, this tarval is returned instead of a new one. So tarvals are + * directly comparable since their representation is unique. * - * DESCRIPTION - * This function creates a new tarval representing the value represented - * by a CString, aka char array. If a tarval representing this value already - * exists, this tarval is returned instead of a new one. So tarvals are - * directly comparable since their representation is unique. + * This function accepts the following strings: * - * PARAMETERS - * str - The String representing the target value - * len - The length of the string - * mode - The mode requested for the result tarval - * - * This function accepts the following strings: - * if mode is int_number: - * 0(x|X)[0-9a-fA-F]+ (hexadecimal representation) - * 0[0-7]* (octal representation) - * (+|-)?[1-9][0-9]* (decimal representation) - * if mode if float_number: - * (+|-)?(decimal int) (. (decimal int))? ((e|E)(+|-)?(decimal int))? - * if mode is boolean: true, True, TRUE ... False... 0, 1, - * if mode is reference: hexadecimal of decimal number as int - * if mode is character: hex or dec - * Leading and/or trailing spaces are ignored + * if mode is int_number: + * - 0(x|X)[0-9a-fA-F]+ (hexadecimal representation) + * - 0[0-7]* (octal representation) + * - (+|-)?[1-9][0-9]* (decimal representation) * - * RESULT - * A tarval of proper type representing the requested value is returned. + * if mode if float_number: + * - (+|-)?(decimal int) (. (decimal int))? ((e|E)(+|-)?(decimal int))? + * + * if mode is boolean: true, True, TRUE ... False... 0, 1, + * + * if mode is reference: hexadecimal of decimal number as int + * + * if mode is character: hex or dec + * + * Leading and/or trailing spaces are ignored + * + * @return + * A tarval of proper type representing the requested value is returned. * Tarvals are unique, so for any value/mode pair at most one tarval will * exist, which will be returned upon further requests with an identical * value/mode pair. * - * NOTES - * If the string is not representable in the given mode an assertion is - * thrown. + * @note + * If the string is not representable in the given mode an assertion is + * thrown in assert build. * - * SEE ALSO + * @sa * irmode.h for predefined modes - * new_tarval_from_long - * new_tarval_from_double - * - ******/ + * new_tarval_from_long() + * new_tarval_from_double() + */ tarval *new_tarval_from_str(const char *str, size_t len, ir_mode *mode); -/****f* tv/new_tarval_from_long - * - * NAME - * new_tarval_from_long - * Constructor function for new tarvals +/** + * Constructor function for new tarvals * - * SYNOPSIS - * tarval *new_tarval_from_long(const long l. ir_mode *mode) + * @param l The long representing the value + * @param mode The mode requested for the result tarval * - * DESCRIPTION - * This function creates a new tarval representing the value represented - * by a long integer. If a tarval representing this value already exists, - * this tarval is returned instead of a new one. So tarvals are directly - * comparable since their representation is unique. + * This function creates a new tarval representing the value represented + * by a long integer. If a tarval representing this value already exists, + * this tarval is returned instead of a new one. So tarvals are directly + * comparable since their representation is unique. * - * PARAMETERS - * l - The long representing the value - * mode - The mode requested for the result tarval - * - * RESULT - * A tarval of proper type representing the requested value is returned. + * @return + * A tarval of proper type representing the requested value is returned. * Tarvals are unique, so for any value/mode pair at most one tarval will * exist, which will be returned upon further requests with an identical * value/mode pair. * - * NOTES - * If the long is not representable in the given mode an assertion is - * thrown. + * @note + * If the long is not representable in the given mode an assertion is + * thrown in assert build. * - * SEE ALSO + * @sa * irmode.h for predefined modes - * new_tarval_from_str - * new_tarval_from_double + * new_tarval_from_str() + * new_tarval_from_double() * - ******/ - + */ tarval *new_tarval_from_long(long l, ir_mode *mode); -/** + +/** Return value as long if possible. + * * This returns a long int with the value represented value, or * gibberish, depending on the size of long int and the size of the - * stored value. It works for e.g. 1 as mode_Ls, but not for + * stored value. It works for e.g. 1 as mode_Ls, but might not work for * get_mode_max(mode_Ls). * This will overflow silently, so use only if you know what - * you are doing! (better check with tarval_is_long...) + * you are doing! (better check with tarval_is_long()...) + * Works only for int modes, even not for character modes! */ -long tarval_to_long(tarval *tv); +long get_tarval_long(tarval *tv); + /** - * This validates if tarval_to_long will return a satisfying + * This validates if get_tarval_long() will return a satisfying * result. I.e. if tv is an int_number and between min, max * of long int (signed!) */ int tarval_is_long(tarval *tv); -/****f* tv/new_tarval_from_double - * - * NAME - * new_tarval_from_double - * Constructor function for new tarvals - * - * SYNOPSIS - * tarval *new_tarval_from_double(const long double d, ir_mode *mode) - * - * DESCRIPTION - * This function creates a new tarval representing the value represented - * by a long double. If a tarval representing this value already exists, - * this tarval is returned instead of a new one. So tarvals are directly - * comparable since their representation is unique. +/** + * Constructor function for new tarvals. * - * PARAMETERS - * d - The long double representing the value - * mode - The mode requested for the result tarval + * @param d The (long) double representing the value + * @param mode The mode requested for the result tarval * - * Only modes of sort float_number can be constructed this way. + * This function creates a new tarval representing the value represented + * by a (long) double. If a tarval representing this value already exists, + * this tarval is returned instead of a new one. So tarvals are directly + * comparable since their representation is unique. + * Only modes of sort float_number can be constructed this way. * - * RESULT - * A tarval of proper type representing the requested value is returned. + * @return + * A tarval of proper type representing the requested value is returned. * Tarvals are unique, so for any value/mode pair at most one tarval will * exist, which will be returned upon further requests with an identical * value/mode pair. * - * NOTES - * If the long double is not representable in the given mode an assertion - * is thrown. This will happen for any mode not of sort float_number + * @note + * If the (long) double is not representable in the given mode an assertion + * is thrown. This will happen for any mode not of sort float_number. * - * SEE ALSO + * @sa * irmode.h for predefined values - * new_tarval_from_str - * new_tarval_from_long - * - ******/ + * new_tarval_from_str() + * new_tarval_from_long() + */ tarval *new_tarval_from_double(long double d, ir_mode *mode); -long double tarval_to_double(tarval *tv); + +/** + * This returns a double with the value represented value, or + * gibberish, depending on the size of double and the size of the + * stored value. + * This will overflow silently, so use only if you know what + * you are doing! (better check with tarval_is_long...) + */ +long double get_tarval_double(tarval *tv); + +/** + * This validates if tarval_to_double() will return a satisfying + * result. I.e. if tv is an float_number and between min, max + * of double + */ int tarval_is_double(tarval *tv); -/* The tarval represents the address of the entity. As the address must - be constant the entity must have as owner the global type. */ -tarval *new_tarval_from_entity (entity *ent, ir_mode *mode); -entity *tarval_to_entity(tarval *tv); -int tarval_is_entity(tarval *tv); + /** ********** Access routines for tarval fields ********** **/ -/****f* tv/get_tarval_* - * +/* * NAME * get_tarval_mode * get_tarval_ ... @@ -271,229 +236,373 @@ int tarval_is_entity(tarval *tv); * * SEE ALSO * the struct tarval + */ + +/** Returns the mode of 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 */ + +/** + * Returns 1 if tv is negative * - ******/ -/* get the mode of the tarval */ -#ifdef TARVAL_ACCESS_DEFINES -# include "tv_t.h" -# define get_tarval_mode(tv) (tv)->mode -#else -ir_mode *get_tarval_mode (tarval *tv); -#endif -/** Testing properties of the represented values **/ -/* Returns 0 if tv is positive, else > 0. @@@ not tested! */ + * @param a the tarval + */ int tarval_is_negative(tarval *a); -/** Some special values **/ -extern tarval *tarval_bad; tarval *get_tarval_bad(void); -extern tarval *tarval_undefined; tarval *get_tarval_undefined(void); -/* These two are the only valid mode_b tarvals! */ -extern tarval *tarval_b_false; tarval *get_tarval_b_false(void); -extern tarval *tarval_b_true; tarval *get_tarval_b_true(void); +/** + * Returns 1 if tv is null + * + * @param a the tarval + */ +int tarval_is_null(tarval *a); + +/** + * Returns 1 if tv is the "one" + * + * @param a the tarval + */ +int tarval_is_one(tarval *a); -extern tarval *tarval_P_void; tarval *get_tarval_P_void(void); +/** The 'bad' tarval. */ +extern tarval *tarval_bad; +/** Returns the 'bad tarval. */ +tarval *get_tarval_bad(void); + +/** The 'undefined' tarval. */ +extern tarval *tarval_undefined; +/** Returns the 'undefined' tarval. */ +tarval *get_tarval_undefined(void); + +/** The mode_b tarval 'false'. */ +extern tarval *tarval_b_false; + +/** Returns the mode_b tarval 'false'. */ +tarval *get_tarval_b_false(void); + +/** The mode_b tarval 'true'. */ +extern tarval *tarval_b_true; +/** Returns the mode_b tarval 'true'. */ +tarval *get_tarval_b_true(void); /* These functions calculate and return a tarval representing the requested * value. * The functions get_mode_{Max,Min,...} return tarvals retrieved from these * functions, but these are stored on initialization of the irmode module and - * therefore the irmode functions should be prefered to the functions below. */ + * 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); + +/** Returns the minimum value of a given mode. */ 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); + +/** Returns the 1 value (multiplicative neutral) of a given mode. */ 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); + +/** Return quite nan for float_number modes. */ tarval *get_tarval_nan(ir_mode *mode); -tarval *get_tarval_inf(ir_mode *mode); -/* ******************** Arithmethic operations on tarvals ******************** */ +/** Return +inf for float_number modes. */ +tarval *get_tarval_plus_inf(ir_mode *mode); -/****f* tv/tarval_cmp - * - * NAME - * tarval_cmp - * Compares two tarvals - * - * SYNOPSIS - * pnc_number tarval_comp(tarval *a, tarval *b) +/** Return -inf for float_number modes. */ +tarval *get_tarval_minus_inf(ir_mode *mode); + +/* ******************** Arithmetic operations on tarvals ******************** */ + +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 */ +} tarval_int_overflow_mode_t; + +/** + * Sets the overflow mode for integer operations. + */ +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); + +/** + * Compares two tarvals * - * DESCRIPTION - * Compare a with b and return a pnc_number describing the relation - * between a and b. This is either Uo, Lt, Eq, Gt, or False if a or b - * are symbolic pointers which can not be compared at all. + * 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. * - * PARAMETERS - * a - A tarval - * b - A tarval - * a and b are tarvals to be compared + * @param a A tarval to be compared + * @param b A tarval to be compared * - * RESULT - * The pnc_number best describing the relation between a and b is returned. + * @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 pnc_number 'Eq' is returned, not 'Ge' which + * tarvals are equal the pn_Cmp 'pn_Cmp_Eq' is returned, not 'pn_Cmp_Ge' which * indicates 'greater or equal' * - * SEE ALSO - * irnode.h for the definition of pnc_numbers - * - ******/ -pnc_number tarval_cmp(tarval *a, tarval *b); + * @sa + * irnode.h for the definition of pn_Cmp + */ +pn_Cmp tarval_cmp(tarval *a, tarval *b); -/****f* tv/tarval_convert_to - * - * NAME - * tarval_convert_to - * Converts a tarval to another mode - * - * SYNOPSIS - * tarval *tarval_convert_to(tarval *src, ir_mode *mode) +/** + * Converts a tarval to another mode. * - * DESCRIPTION - * Convert tarval 'src' to mode 'mode', this will suceed if and only if mode - * 'mode' is wider than the mode of src, as defined in the firm documentation - * and as returned by the function mode_is_smaller defined in irmode.h. + * Convert tarval 'src' to mode 'mode', this will succeed if and only if mode + * 'mode' is wider than the mode of src, as defined in the firm documentation + * and as returned by the function mode_is_smaller defined in irmode.h. * - * PARAMETERS - * src - The tarval to convert - * mode - Tho mode to convert to + * @param src The tarval to convert + * @param mode Tho mode to convert to * - * RESULT - * If a tarval of mode 'mode' with the result of the conversion of the 'src' + * @return + * If a tarval of mode 'mode' with the result of the conversion of the 'src' * tarvals value already exists, it will be returned, else a new tarval is * constructed and returned * - * NOTES + * @note * Illegal conversations will trigger an assertion * - * SEE ALSO + * @sa * FIRM documentation for conversion rules * mode_is_smaller defined in irmode.h - * - ******/ -tarval *tarval_convert_to(tarval *src, ir_mode *m); + */ +tarval *tarval_convert_to(tarval *src, ir_mode *mode); -/****f* tv/tarval_calculations - * - * NAME - * tarval_neg - Negation of a tarval - * tarval_add - Addition of two tarvals - * tarval_sub - Subtraction from a tarval - * tarval_mul - Multiplication of tarvals - * tarval_quo - 'Exact' division - * tarval_div - Integer division - * tarval_mod - Remainder of integer division - * tarval_abs - Absolute value - * tarval_and - Bitwise and - * tarval_or - Bitwise or - * tarval_eor - Bitwise exclusive or - * tarval_shl - Left shift - * tarval_shr - Unsigned right shift - * tarval_shrs - Signed right shift - * tarval_rot - Rotation - * - * SYNOPSIS - * tarval *tarval_neg (tarval *a) - * tarval *tarval_add (tarval *a, tarval *b) - * tarval *tarval_sub (tarval *a, tarval *b) - * tarval *tarval_mul (tarval *a, tarval *b) - * tarval *tarval_quo (tarval *a, tarval *b) - * tarval *tarval_div (tarval *a, tarval *b) - * tarval *tarval_mod (tarval *a, tarval *b) - * tarval *tarval_abs (tarval *a) - * tarval *tarval_and (tarval *a, tarval *b) - * tarval *tarval_or (tarval *a, tarval *b) - * tarval *tarval_eor (tarval *a, tarval *b) - * tarval *tarval_shl (tarval *a, tarval *b) - * tarval *tarval_shr (tarval *a, tarval *b) - * tarval *tarval_shrs(tarval *a, tarval *b) - * tarval *tarval_rot (tarval *a, tarval *b) - * - * DESCRIPTION - * These function implement basic computations representable as opcodes - * in FIRM nodes. +/* + * These function implement basic computations representable as opcodes + * in FIRM nodes. * * PARAMETERS * tarval_neg: * traval_abs: * a - the tarval to operate on * - * all oters: + * all others: * a - the first operand tarval * b - the second operand tarval * * RESULT - * If neccessary a new tarval is constructed for the resulting value, + * If necessary a new tarval is constructed for the resulting value, * or the one already carrying the computation result is retrieved and * returned as result. * * NOTES - * The order the arguments are given in is important, imagine postfix + * The order the arguments are given in is important, imagine postfix * notation. - * Illegal operations will trigger an assertion. - * The sort member of the struct mode defines which operations are valid + * Illegal operations will trigger an assertion. + * The sort member of the struct mode defines which operations are valid + */ + +/** bitwise Negation of a tarval. */ +tarval *tarval_not(tarval *a); + +/** arithmetic Negation of a tarval. */ +tarval *tarval_neg(tarval *a); + +/** Addition of two tarvals. */ +tarval *tarval_add(tarval *a, tarval *b); + +/** Subtraction from a tarval. */ +tarval *tarval_sub(tarval *a, tarval *b); + +/** Multiplication of tarvals. */ +tarval *tarval_mul(tarval *a, tarval *b); + +/** 'Exact' division. */ +tarval *tarval_quo(tarval *a, tarval *b); + +/** Integer division. */ +tarval *tarval_div(tarval *a, tarval *b); + +/** Remainder of integer division. */ +tarval *tarval_mod(tarval *a, tarval *b); + +/** Absolute value. */ +tarval *tarval_abs(tarval *a); + +/** Bitwise and. */ +tarval *tarval_and(tarval *a, tarval *b); + +/** Bitwise or. */ +tarval *tarval_or(tarval *a, tarval *b); + +/** Bitwise exclusive or. */ +tarval *tarval_eor(tarval *a, tarval *b); + +/** Left shift. */ +tarval *tarval_shl(tarval *a, tarval *b); + +/** Unsigned (logical) right shift. */ +tarval *tarval_shr(tarval *a, tarval *b); + +/** Signed (arithmetic) right shift. */ +tarval *tarval_shrs(tarval *a, tarval *b); + +/** Rotation. */ +tarval *tarval_rot(tarval *a, tarval *b); + +/** Carry flag of the last operation */ +int tarval_carry(void); + +/* *********** Output of tarvals *********** */ + +/** + * The output mode for tarval values. * - ******/ -tarval *tarval_neg(tarval *a); /* negation */ -tarval *tarval_add(tarval *a, tarval *b); /* addition */ -tarval *tarval_sub(tarval *a, tarval *b); /* subtraction */ -tarval *tarval_mul(tarval *a, tarval *b); /* multiplication */ -tarval *tarval_quo(tarval *a, tarval *b); /* floating point division */ -tarval *tarval_div(tarval *a, tarval *b); /* integer division */ -tarval *tarval_mod(tarval *a, tarval *b); /* remainder */ -tarval *tarval_abs(tarval *a); /* absolute value */ -tarval *tarval_and(tarval *a, tarval *b); /* bitwise and */ -tarval *tarval_or (tarval *a, tarval *b); /* bitwise or */ -tarval *tarval_eor(tarval *a, tarval *b); /* bitwise exclusive or (xor) */ -tarval *tarval_shl(tarval *a, tarval *b); /* bitwise left shift */ -tarval *tarval_shr(tarval *a, tarval *b); /* bitwise unsigned right shift */ -tarval *tarval_shrs(tarval *a, tarval *b); /* bitwise signed right shift */ -tarval *tarval_rot(tarval *a, tarval *b); /* bitwise rotation */ - -/** *********** Output of tarvals *********** **/ -/****f* tv/tarval_bitpattern + * Some modes allow more that one representation, for instance integers + * can be represented hex or decimal. Of course it would be enough to have + * one and let every backend convert it into the 'right' one. + * However, we can do this in the tarval much simpler... + */ +typedef enum { + TVO_NATIVE, /**< the default output mode, depends on the mode */ + TVO_HEX, /**< use hex representation, always possible */ + TVO_DECIMAL, /**< use decimal representation */ + TVO_OCTAL, /**< use octal representation */ + TVO_BINARY, /**< use binary representation */ + TVO_FLOAT, /**< use floating point representation (i.e 1.342e-2)*/ + TVO_HEXFLOAT /**< use hexadecimal floating point representation (i.e 0x1.ea32p-12)*/ +} tv_output_mode; + +/** + * This structure contains helper information to format the output + * of a tarval of a mode. + */ +typedef struct tarval_mode_info { + tv_output_mode mode_output; /**< if != TVO_NATIVE select a special mode */ + const char *mode_prefix; /**< if set, this prefix will be printed + before a value of this mode */ + const char *mode_suffix; /**< if set, this suffix will be printed + after a value of this mode */ +} tarval_mode_info; + +/** + * Specify the output options of one mode. * - * NAME - * tarval_bitpattern - * Bit representation of a tarval value, as string of '0' and '1' + * This functions stores the mode info, so DO NOT DESTROY it. * - * SYNOPSIS - * char *tarval_bitpattern(tarval *tv) + * @param mode a ir_mode that should be associated + * @param modeinfo the output format info * - * DESCRIPTION - * This function returns a printable bit representation of any value - * stored as tarval. This representation is a null terminated C string. + * @return zero on success. + */ +int set_tarval_mode_output_option(ir_mode *mode, const tarval_mode_info *modeinfo); + +/** + * Returns the output options of one mode. * - * PARAMETERS - * tv - The tarval + * This functions returns the mode info of a given mode. * - * RESULT - * As usual in C a pointer to a char is returned. The length of the + * @param mode a ir_mode that should be associated + * + * @return the output option + */ +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' + * + * @param tv The tarval + * + * This function returns a printable bit representation of any value + * stored as tarval. This representation is a null terminated C string. + * + * @return + * As usual in C a pointer to a char is returned. The length of the * returned string if fixed, just read as many chars as the mode defines * as size. * - * NOTE - * The string is allocated using malloc() and is free()ed on the next call - * of this function. - * The string consists of the ascii characters '0' and '1' and is - * null terminated + * @note + * The string is allocated using malloc() and is free()ed on the next call + * of this function. + * The string consists of the ASCII characters '0' and '1' and is + * null terminated * - * SEE ALSO + * @sa * irmode.h for the definition of the ir_mode struct * the size member of aforementioned struct + */ +char *get_tarval_bitpattern(tarval *tv); + +/** + * Returns the bitpattern of the bytes_ofs byte. * - ******/ -char *tarval_bitpattern(tarval *tv); + * This function succeeds even if the mode of the tarval uses lesser bits + * than requested, in that case the bitpattern is filled with zero bits. + * + * To query a 32bit value the following code can be used: + * + * val0 = tarval_sub_bits(tv, 0); + * val1 = tarval_sub_bits(tv, 1); + * val2 = tarval_sub_bits(tv, 2); + * val3 = tarval_sub_bits(tv, 3); + * + * Because this is the bit representation of the target machine, only the following + * operations are legal on the result: + * + * - concatenation (endian dependence MUST be handled by the CALLER) + * - bitwise logical operations to select/mask bits + * + * @param tv the tarval + * @param byte_ofs the byte offset + * + * @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); /** - * returns bitpattern [from, to[ + * Return values of tarval classify */ -char *tarval_sub_bitpattern(tarval *tv, int from, int to); +typedef enum _tarval_classification_t { + TV_CLASSIFY_NULL = 0, /**< the tarval represents the additive neutral element */ + TV_CLASSIFY_ONE = +1, /**< the tarval represents the multiplicative neutral element */ + TV_CLASSIFY_ALL_ONE = -1, /**< the tarval represents the bitwise-and neutral element */ + TV_CLASSIFY_OTHER = 2 /**< all other tarvals */ +} tarval_classification_t; -/* Identifying some tarvals ??? */ -/* This function is deprecated and its use strongly discouraged */ -long tarval_classify(tarval *tv); +/** + * Identifying tarvals values for algebraic simplifications. + * + * @param tv the tarval + * + * @return + * - TV_CLASSIFY_NULL for additive neutral or the NULL tarval for reference modes, + * - TV_CLASSIFY_ONE for multiplicative neutral, + * - TV_CLASSIFY_ALL_ONE for bitwise-and neutral + * - TV_CLASSIFY_OTHER else + */ +tarval_classification_t classify_tarval(tarval *tv); + +/** + * Returns non-zero if a given (integer) tarval has only one single bit + * set. + */ +int is_single_bit_tarval(tarval *tv); + +/** + * Output of tarvals to a buffer. + */ +int tarval_snprintf(char *buf, size_t buflen, tarval *tv); -/** Initialization of the tarval module **/ -void init_tarval_1(void); /* call before init_mode */ -void init_tarval_2(void); /* call after init_mode */ +/** + * Output of tarvals to stdio. + */ +int tarval_printf(tarval *tv); #endif /* _TV_H_ */