strcalc.h 5.79 KB
Newer Older
Christian Würdig's avatar
Christian Würdig committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
/*
 * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
 *
 * This file is part of libFirm.
 *
 * This file may be distributed and/or modified under the terms of the
 * GNU General Public License version 2 as published by the Free Software
 * Foundation and appearing in the file LICENSE.GPL included in the
 * packaging of this file.
 *
 * Licensees holding valid libFirm Professional Edition licenses may use
 * this file in accordance with the libFirm Commercial License.
 * Agreement provided with the Software.
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE.
 */

20
/**
Michael Beck's avatar
Michael Beck committed
21
22
23
24
25
26
 * @file
 * @brief    Provides basic mathematical operations on values represented as strings.
 * @date     2003
 * @author   Mathias Heil
 * @version  $Id$
 * @summary
27
 *
28
29
30
31
 * The module uses a string to represent values, and provides operations
 * to perform calculations with these values.
 * Results are stored in an internal buffer, so you have to make a copy
 * of them if you need to store the result.
32
 *
33
 */
Michael Beck's avatar
Michael Beck committed
34
35
#ifndef FIRM_TV_STRCALC_H
#define FIRM_TV_STRCALC_H
36

37
38
#include "irmode.h"

39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
#ifdef STRCALC_DEBUG_ALL             /* switch on all debug options */
#  ifndef STRCALC_DEBUG
#    define STRCALC_DEBUG            /* switch on debug output */
#  endif
#  ifndef STRCALC_DEBUG_PRINTCOMP    /* print arguments and result of each computation */
#    define STRCALC_DEBUG_PRINTCOMP
#  endif
#  ifndef STRCALC_DEBUG_FULLPRINT
#    define STRCALC_DEBUG_FULLPRINT  /* print full length of values (e.g. 128 bit instead of 64 bit using default init) */
#  endif
#  ifndef STRCALC_DEBUG_GROUPPRINT
#    define STRCALC_DEBUG_GROUPPRINT /* print spaces after each 8 bits */
#  endif
#endif

/*
 * constants, typedefs, enums
 */

58
#define SC_DEFAULT_PRECISION 64
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

enum {
  SC_0 = 0,
  SC_1,
  SC_2,
  SC_3,
  SC_4,
  SC_5,
  SC_6,
  SC_7,
  SC_8,
  SC_9,
  SC_A,
  SC_B,
  SC_C,
  SC_D,
  SC_E,
Till Riedel's avatar
Till Riedel committed
76
  SC_F
77
78
};

79
/**
Michael Beck's avatar
Michael Beck committed
80
 * The output mode for integer values.
81
82
 */
enum base_t {
Florian Liekweg's avatar
Florian Liekweg committed
83
84
85
86
87
  SC_hex,   /**< hexadecimal output with small letters */
  SC_HEX,   /**< hexadecimal output with BIG letters */
  SC_DEC,   /**< decimal output */
  SC_OCT,   /**< octal output */
  SC_BIN    /**< binary output */
88
89
};

90
91
/**
 * buffer = value1 + value2
92
 */
Michael Beck's avatar
Michael Beck committed
93
void sc_add(const void *value1, const void *value2, void *buffer);
94
95
96
97

/**
 * buffer = value1 - value2
 */
Michael Beck's avatar
Michael Beck committed
98
void sc_sub(const void *value1, const void *value2, void *buffer);
99
100
101
102

/**
 * buffer = -value
 */
Michael Beck's avatar
Michael Beck committed
103
void sc_neg(const void *value, void *buffer);
104
105
106
107

/**
 * buffer = value1 & value2
 */
Michael Beck's avatar
Michael Beck committed
108
void sc_and(const void *value1, const void *value2, void *buffer);
109
110
111
112

/**
 * buffer = value1 | value2
 */
Michael Beck's avatar
Michael Beck committed
113
void sc_or(const void *value1, const void *value2, void *buffer);
114
115
116
117

/**
 * buffer = value1 ^ value2
 */
Michael Beck's avatar
Michael Beck committed
118
void sc_xor(const void *value1, const void *value2, void *buffer);
119
120
121
122
123
124
125
126
127

/**
 * buffer = ~value
 */
void sc_not(const void *value, void *buffer);

/**
 * buffer = value1 * value2
 */
Michael Beck's avatar
Michael Beck committed
128
void sc_mul(const void *value1, const void *value2, void *buffer);
129
130
131
132

/**
 * buffer = value1 / value2
 */
133
void sc_div(const void *value1, const void *value2, void *buffer);
134
135
136
137

/**
 * buffer = value1 % value2
 */
Michael Beck's avatar
Michael Beck committed
138
void sc_mod(const void *value1, const void *value2, void *buffer);
139

Michael Beck's avatar
Michael Beck committed
140
141
142
143
144
145
/**
 * div_buffer = value1 / value2
 * mod_buffer = value1 % value2
 */
void sc_divmod(const void *value1, const void *value2, void *div_buffer, void *mod_buffer);

146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
/**
 * buffer = value1 << value2
 */
void sc_shl(const void *value1, const void *value2, int radius, int sign, void *buffer);

/**
 * buffer = value1 >>u value2
 */
void sc_shr(const void *value1, const void *value2, int radius, int sign, void *buffer);

/**
 * buffer = value1 >>s value2
 */
void sc_shrs(const void *value1, const void *value2, int radius, int sign, void *buffer);

/**
 * buffer = value1 <<>> value2
 */
void sc_rot(const void *value1, const void *value2, int radius, int sign, void *buffer);
165

166
/*
167
 * function declarations
168
 */
169
const void *sc_get_buffer(void);
Michael Beck's avatar
Michael Beck committed
170
int sc_get_buffer_length(void);
171

172
void sign_extend(void *buffer, ir_mode *mode);
Michael Beck's avatar
BugFix:    
Michael Beck committed
173

174
175
176
177
/** create an value form a string representation */
void sc_val_from_str(const char *str, unsigned int len, void *buffer, ir_mode *mode);

/** create a value from a long */
178
void sc_val_from_long(long l, void *buffer);
179
180

/** create a value form an unsigned long */
181
void sc_val_from_ulong(unsigned long l, void *buffer);
182
183

/** converts a value to a long */
Michael Beck's avatar
Michael Beck committed
184
long sc_val_to_long(const void *val);
185
186
void sc_min_from_bits(unsigned int num_bits, unsigned int sign, void *buffer);
void sc_max_from_bits(unsigned int num_bits, unsigned int sign, void *buffer);
187

188
189
190
/**
 * Compares val1 and val2
 */
191
192
int  sc_comp(const void *val1, const void *val2);

Matthias Heil's avatar
Matthias Heil committed
193
194
int sc_get_highest_set_bit(const void *value);
int sc_get_lowest_set_bit(const void *value);
195
196
197
int sc_is_zero(const void *value);
int sc_is_negative(const void *value);
int sc_had_carry(void);
198
199
200
201
202
203
204
205

/**
 * Return the bits of a tarval at a given byte-offset.
 *
 * @param value     the value
 * @param len       number of valid bits in the value
 * @param byte_ofs  the byte offset
 */
Matthias Heil's avatar
Matthias Heil committed
206
unsigned char sc_sub_bits(const void *value, int len, unsigned byte_ofs);
207

208
209
210
/**
 * Converts a tarval into a string.
 *
211
212
213
214
 * @param val1        the value pointer
 * @param bits        number of valid bits in this value
 * @param base        output base
 * @param signed_mode print it signed (only decimal mode supported
215
 */
216
const char *sc_print(const void *val1, unsigned bits, enum base_t base, int signed_mode);
217

Michael Beck's avatar
Michael Beck committed
218
/** Initialize the strcalc module.
219
220
221
222
223
224
 * Sets up internal data structures and constants
 * After the first call subsequent calls have no effect
 *
 * @param precision_in_bytes Specifies internal precision to be used
 *   for calculations. The reason for being multiples of 8 eludes me
 */
Matthias Heil's avatar
Matthias Heil committed
225
void init_strcalc(int precision_in_bytes);
226
void finish_strcalc(void);
227
int sc_get_precision(void);
Matthias Heil's avatar
Matthias Heil committed
228

Michael Beck's avatar
Michael Beck committed
229
#endif /* FIRM_TV_STRCALC_H */