tv.h

/*
 * This file is part of libFirm.
 * Copyright (C) 2012 University of Karlsruhe.
 */

#ifndef FIRM_TV_TV_H
#define FIRM_TV_TV_H

#include <stddef.h>
#include "firm_types.h"

#include "begin.h"

FIRM_API ir_tarval *new_tarval_from_str(const char *str, size_t len,
                                        ir_mode *mode);

FIRM_API ir_tarval *new_integer_tarval_from_str(const char *str, size_t len,
                                                int negative,
                                                unsigned char base,
                                                ir_mode *mode);

FIRM_API ir_tarval *new_tarval_from_long(long l, ir_mode *mode);

FIRM_API ir_tarval *new_tarval_from_bytes(unsigned char const *buf,
                                          ir_mode *mode);

FIRM_API ir_tarval *new_tarval_nan(ir_mode *mode, int signaling,
                                   ir_tarval const *payload);

FIRM_API void tarval_to_bytes(unsigned char *buffer, ir_tarval const *tv);

FIRM_API long get_tarval_long(ir_tarval const *tv);

FIRM_API int tarval_is_long(ir_tarval const *tv);

FIRM_API ir_tarval *new_tarval_from_double(double d, ir_mode *mode);

FIRM_API ir_tarval *new_tarval_from_long_double(long double d, ir_mode *mode);

FIRM_API double get_tarval_double(ir_tarval const *tv);

FIRM_API long double get_tarval_long_double(ir_tarval const *tv);

FIRM_API int tarval_is_double(ir_tarval const *tv);

FIRM_API ir_mode *get_tarval_mode(ir_tarval const *tv);

FIRM_API int tarval_is_negative(ir_tarval const *tv);

FIRM_API int tarval_is_null(ir_tarval const *tv);

FIRM_API int tarval_is_one(ir_tarval const *tv);

FIRM_API int tarval_is_all_one(ir_tarval const *tv);

FIRM_API int tarval_is_constant(ir_tarval const *tv);

FIRM_API ir_tarval *const tarval_bad;
FIRM_API ir_tarval *get_tarval_bad(void);

FIRM_API ir_tarval *const tarval_unknown;
FIRM_API ir_tarval *get_tarval_unknown(void);

FIRM_API ir_tarval *tarval_b_false;
FIRM_API ir_tarval *get_tarval_b_false(void);

FIRM_API ir_tarval *tarval_b_true;
FIRM_API ir_tarval *get_tarval_b_true(void);

FIRM_API void tarval_set_wrap_on_overflow(int wrap_on_overflow);

FIRM_API int tarval_get_wrap_on_overflow(void);

FIRM_API ir_relation tarval_cmp(ir_tarval const *a, ir_tarval const *b);

FIRM_API ir_tarval *tarval_convert_to(ir_tarval const *src, ir_mode *mode);

FIRM_API ir_tarval *tarval_bitcast(ir_tarval const *src, ir_mode *mode);

/*
 * These function implement basic computations representable as opcodes
 * in FIRM nodes.
 *
 * PARAMETERS
 *    tarval_neg:
 *    traval_abs:
 *      a - the tarval to operate on
 *
 *    all others:
 *      a - the first operand tarval
 *      b - the second operand tarval
 *
 * RESULT
 *    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
 *   notation.
 *   Illegal operations will trigger an assertion.
 *   The sort member of the struct mode defines which operations are valid
 */

FIRM_API ir_tarval *tarval_not(ir_tarval const *a);

FIRM_API ir_tarval *tarval_neg(ir_tarval const *a);

FIRM_API ir_tarval *tarval_add(ir_tarval const *a, ir_tarval const *b);

FIRM_API ir_tarval *tarval_sub(ir_tarval const *a, ir_tarval const *b);

FIRM_API ir_tarval *tarval_mul(ir_tarval const *a, ir_tarval const *b);

FIRM_API ir_tarval *tarval_div(ir_tarval const *a, ir_tarval const *b);

FIRM_API ir_tarval *tarval_mod(ir_tarval const *a, ir_tarval const *b);

FIRM_API ir_tarval *tarval_divmod(ir_tarval const *a, ir_tarval const *b,
                                  ir_tarval **mod_res);

FIRM_API ir_tarval *tarval_abs(ir_tarval const *a);

FIRM_API ir_tarval *tarval_and(ir_tarval const *a, ir_tarval const *b);

FIRM_API ir_tarval *tarval_andnot(ir_tarval const *a, ir_tarval const *b);

FIRM_API ir_tarval *tarval_or(ir_tarval const *a, ir_tarval const *b);

FIRM_API ir_tarval *tarval_ornot(ir_tarval const *a, ir_tarval const *b);

FIRM_API ir_tarval *tarval_eor(ir_tarval const *a, ir_tarval const *b);

FIRM_API ir_tarval *tarval_shl(ir_tarval const *a, ir_tarval const *b);

FIRM_API ir_tarval *tarval_shl_unsigned(ir_tarval const *a, unsigned b);

FIRM_API ir_tarval *tarval_shr(ir_tarval const *a, ir_tarval const *b);

FIRM_API ir_tarval *tarval_shr_unsigned(ir_tarval const *a, unsigned b);

FIRM_API ir_tarval *tarval_shrs(ir_tarval const *a, ir_tarval const *b);

FIRM_API ir_tarval *tarval_shrs_unsigned(ir_tarval const *a, unsigned b);

FIRM_API unsigned char get_tarval_sub_bits(ir_tarval const *tv, unsigned byte_ofs);

FIRM_API int get_tarval_popcount(ir_tarval const *tv);

FIRM_API int get_tarval_lowest_bit(ir_tarval const *tv);

FIRM_API int get_tarval_highest_bit(ir_tarval const *tv);

FIRM_API int tarval_zero_mantissa(ir_tarval const *tv);

FIRM_API int tarval_get_exponent(ir_tarval const *tv);

FIRM_API int tarval_ieee754_can_conv_lossless(ir_tarval const *tv, const ir_mode *mode);

FIRM_API unsigned tarval_ieee754_get_exact(void);

FIRM_API int tarval_is_nan(ir_tarval const *tv);

FIRM_API int tarval_is_quiet_nan(ir_tarval const *tv);

FIRM_API int tarval_is_signaling_nan(ir_tarval const *tv);

FIRM_API int tarval_is_finite(ir_tarval const *tv);

#include "end.h"

#endif