Home | History | Annotate | Line # | Download | only in softfloat
softfloat.h revision 1.6
      1 /*	$NetBSD: softfloat.h,v 1.6 2011/07/04 08:02:34 matt Exp $	*/
      2 
      3 /* This is a derivative work. */
      4 
      5 /*
      6 ===============================================================================
      7 
      8 This C header file is part of the SoftFloat IEC/IEEE Floating-point
      9 Arithmetic Package, Release 2a.
     10 
     11 Written by John R. Hauser.  This work was made possible in part by the
     12 International Computer Science Institute, located at Suite 600, 1947 Center
     13 Street, Berkeley, California 94704.  Funding was partially provided by the
     14 National Science Foundation under grant MIP-9311980.  The original version
     15 of this code was written as part of a project to build a fixed-point vector
     16 processor in collaboration with the University of California at Berkeley,
     17 overseen by Profs. Nelson Morgan and John Wawrzynek.  More information
     18 is available through the Web page `http://HTTP.CS.Berkeley.EDU/~jhauser/
     19 arithmetic/SoftFloat.html'.
     20 
     21 THIS SOFTWARE IS DISTRIBUTED AS IS, FOR FREE.  Although reasonable effort
     22 has been made to avoid it, THIS SOFTWARE MAY CONTAIN FAULTS THAT WILL AT
     23 TIMES RESULT IN INCORRECT BEHAVIOR.  USE OF THIS SOFTWARE IS RESTRICTED TO
     24 PERSONS AND ORGANIZATIONS WHO CAN AND WILL TAKE FULL RESPONSIBILITY FOR ANY
     25 AND ALL LOSSES, COSTS, OR OTHER PROBLEMS ARISING FROM ITS USE.
     26 
     27 Derivative works are acceptable, even for commercial purposes, so long as
     28 (1) they include prominent notice that the work is derivative, and (2) they
     29 include prominent notice akin to these four paragraphs for those parts of
     30 this code that are retained.
     31 
     32 ===============================================================================
     33 */
     34 
     35 /*
     36 -------------------------------------------------------------------------------
     37 The macro `FLOATX80' must be defined to enable the extended double-precision
     38 floating-point format `floatx80'.  If this macro is not defined, the
     39 `floatx80' type will not be defined, and none of the functions that either
     40 input or output the `floatx80' type will be defined.  The same applies to
     41 the `FLOAT128' macro and the quadruple-precision format `float128'.
     42 -------------------------------------------------------------------------------
     43 */
     44 /* #define FLOATX80 */
     45 /* #define FLOAT128 */
     46 
     47 #include <machine/ieeefp.h>
     48 
     49 /*
     50 -------------------------------------------------------------------------------
     51 Software IEC/IEEE floating-point types.
     52 -------------------------------------------------------------------------------
     53 */
     54 typedef unsigned int float32;
     55 typedef unsigned long long float64;
     56 #ifdef FLOATX80
     57 typedef struct {
     58     unsigned short high;
     59     unsigned long long low;
     60 } floatx80;
     61 #endif
     62 #ifdef FLOAT128
     63 typedef struct {
     64     unsigned long long high, low;
     65 } float128;
     66 #endif
     67 
     68 /*
     69 -------------------------------------------------------------------------------
     70 Software IEC/IEEE floating-point underflow tininess-detection mode.
     71 -------------------------------------------------------------------------------
     72 */
     73 #ifndef SOFTFLOAT_FOR_GCC
     74 extern int8 float_detect_tininess;
     75 #endif
     76 enum {
     77     float_tininess_after_rounding  = 0,
     78     float_tininess_before_rounding = 1
     79 };
     80 
     81 /*
     82 -------------------------------------------------------------------------------
     83 Software IEC/IEEE floating-point rounding mode.
     84 -------------------------------------------------------------------------------
     85 */
     86 extern fp_rnd float_rounding_mode;
     87 enum {
     88     float_round_nearest_even = FP_RN,
     89     float_round_to_zero      = FP_RZ,
     90     float_round_down         = FP_RM,
     91     float_round_up           = FP_RP
     92 };
     93 
     94 /*
     95 -------------------------------------------------------------------------------
     96 Software IEC/IEEE floating-point exception flags.
     97 -------------------------------------------------------------------------------
     98 */
     99 extern fp_except float_exception_flags;
    100 extern fp_except float_exception_mask;
    101 enum {
    102     float_flag_inexact   = FP_X_IMP,
    103     float_flag_underflow = FP_X_UFL,
    104     float_flag_overflow  = FP_X_OFL,
    105     float_flag_divbyzero = FP_X_DZ,
    106     float_flag_invalid   = FP_X_INV
    107 };
    108 
    109 /*
    110 -------------------------------------------------------------------------------
    111 Routine to raise any or all of the software IEC/IEEE floating-point
    112 exception flags.
    113 -------------------------------------------------------------------------------
    114 */
    115 void float_raise( fp_except );
    116 
    117 /*
    118 -------------------------------------------------------------------------------
    119 Software IEC/IEEE integer-to-floating-point conversion routines.
    120 -------------------------------------------------------------------------------
    121 */
    122 float32 int32_to_float32( int32 );
    123 float32 uint32_to_float32( uint32 );
    124 float64 int32_to_float64( int32 );
    125 float64 uint32_to_float64( uint32 );
    126 #ifdef FLOATX80
    127 floatx80 int32_to_floatx80( int32 );
    128 floatx80 uint32_to_floatx80( uint32 );
    129 #endif
    130 #ifdef FLOAT128
    131 float128 int32_to_float128( int32 );
    132 float128 uint32_to_float128( uint32 );
    133 #endif
    134 float32 int64_to_float32( long long );
    135 float64 int64_to_float64( long long );
    136 #ifdef FLOATX80
    137 floatx80 int64_to_floatx80( long long );
    138 #endif
    139 #ifdef FLOAT128
    140 float128 int64_to_float128( long long );
    141 #endif
    142 
    143 /*
    144 -------------------------------------------------------------------------------
    145 Software IEC/IEEE single-precision conversion routines.
    146 -------------------------------------------------------------------------------
    147 */
    148 int float32_to_int32( float32 );
    149 int float32_to_int32_round_to_zero( float32 );
    150 unsigned int float32_to_uint32_round_to_zero( float32 );
    151 long long float32_to_int64( float32 );
    152 long long float32_to_int64_round_to_zero( float32 );
    153 float64 float32_to_float64( float32 );
    154 #ifdef FLOATX80
    155 floatx80 float32_to_floatx80( float32 );
    156 #endif
    157 #ifdef FLOAT128
    158 float128 float32_to_float128( float32 );
    159 #endif
    160 
    161 /*
    162 -------------------------------------------------------------------------------
    163 Software IEC/IEEE single-precision operations.
    164 -------------------------------------------------------------------------------
    165 */
    166 float32 float32_round_to_int( float32 );
    167 float32 float32_add( float32, float32 );
    168 float32 float32_sub( float32, float32 );
    169 float32 float32_mul( float32, float32 );
    170 float32 float32_div( float32, float32 );
    171 float32 float32_rem( float32, float32 );
    172 float32 float32_sqrt( float32 );
    173 flag float32_eq( float32, float32 );
    174 flag float32_le( float32, float32 );
    175 flag float32_lt( float32, float32 );
    176 flag float32_eq_signaling( float32, float32 );
    177 flag float32_le_quiet( float32, float32 );
    178 flag float32_lt_quiet( float32, float32 );
    179 #ifndef SOFTFLOAT_FOR_GCC
    180 flag float32_is_signaling_nan( float32 );
    181 #endif
    182 
    183 /*
    184 -------------------------------------------------------------------------------
    185 Software IEC/IEEE double-precision conversion routines.
    186 -------------------------------------------------------------------------------
    187 */
    188 int float64_to_int32( float64 );
    189 int float64_to_int32_round_to_zero( float64 );
    190 unsigned int float64_to_uint32_round_to_zero( float64 );
    191 long long float64_to_int64( float64 );
    192 long long float64_to_int64_round_to_zero( float64 );
    193 float32 float64_to_float32( float64 );
    194 #ifdef FLOATX80
    195 floatx80 float64_to_floatx80( float64 );
    196 #endif
    197 #ifdef FLOAT128
    198 float128 float64_to_float128( float64 );
    199 #endif
    200 
    201 /*
    202 -------------------------------------------------------------------------------
    203 Software IEC/IEEE double-precision operations.
    204 -------------------------------------------------------------------------------
    205 */
    206 float64 float64_round_to_int( float64 );
    207 float64 float64_add( float64, float64 );
    208 float64 float64_sub( float64, float64 );
    209 float64 float64_mul( float64, float64 );
    210 float64 float64_div( float64, float64 );
    211 float64 float64_rem( float64, float64 );
    212 float64 float64_sqrt( float64 );
    213 flag float64_eq( float64, float64 );
    214 flag float64_le( float64, float64 );
    215 flag float64_lt( float64, float64 );
    216 flag float64_eq_signaling( float64, float64 );
    217 flag float64_le_quiet( float64, float64 );
    218 flag float64_lt_quiet( float64, float64 );
    219 #ifndef SOFTFLOAT_FOR_GCC
    220 flag float64_is_signaling_nan( float64 );
    221 #endif
    222 
    223 #ifdef FLOATX80
    224 
    225 /*
    226 -------------------------------------------------------------------------------
    227 Software IEC/IEEE extended double-precision conversion routines.
    228 -------------------------------------------------------------------------------
    229 */
    230 int floatx80_to_int32( floatx80 );
    231 int floatx80_to_int32_round_to_zero( floatx80 );
    232 long long floatx80_to_int64( floatx80 );
    233 long long floatx80_to_int64_round_to_zero( floatx80 );
    234 float32 floatx80_to_float32( floatx80 );
    235 float64 floatx80_to_float64( floatx80 );
    236 #ifdef FLOAT128
    237 float128 floatx80_to_float128( floatx80 );
    238 #endif
    239 
    240 /*
    241 -------------------------------------------------------------------------------
    242 Software IEC/IEEE extended double-precision rounding precision.  Valid
    243 values are 32, 64, and 80.
    244 -------------------------------------------------------------------------------
    245 */
    246 extern int floatx80_rounding_precision;
    247 
    248 /*
    249 -------------------------------------------------------------------------------
    250 Software IEC/IEEE extended double-precision operations.
    251 -------------------------------------------------------------------------------
    252 */
    253 floatx80 floatx80_round_to_int( floatx80 );
    254 floatx80 floatx80_add( floatx80, floatx80 );
    255 floatx80 floatx80_sub( floatx80, floatx80 );
    256 floatx80 floatx80_mul( floatx80, floatx80 );
    257 floatx80 floatx80_div( floatx80, floatx80 );
    258 floatx80 floatx80_rem( floatx80, floatx80 );
    259 floatx80 floatx80_sqrt( floatx80 );
    260 flag floatx80_eq( floatx80, floatx80 );
    261 flag floatx80_le( floatx80, floatx80 );
    262 flag floatx80_lt( floatx80, floatx80 );
    263 flag floatx80_eq_signaling( floatx80, floatx80 );
    264 flag floatx80_le_quiet( floatx80, floatx80 );
    265 flag floatx80_lt_quiet( floatx80, floatx80 );
    266 flag floatx80_is_signaling_nan( floatx80 );
    267 
    268 #endif
    269 
    270 #ifdef FLOAT128
    271 
    272 /*
    273 -------------------------------------------------------------------------------
    274 Software IEC/IEEE quadruple-precision conversion routines.
    275 -------------------------------------------------------------------------------
    276 */
    277 int float128_to_int32( float128 );
    278 int float128_to_int32_round_to_zero( float128 );
    279 long long float128_to_int64( float128 );
    280 long long float128_to_int64_round_to_zero( float128 );
    281 float32 float128_to_float32( float128 );
    282 float64 float128_to_float64( float128 );
    283 #ifdef FLOATX80
    284 floatx80 float128_to_floatx80( float128 );
    285 #endif
    286 
    287 /*
    288 -------------------------------------------------------------------------------
    289 Software IEC/IEEE quadruple-precision operations.
    290 -------------------------------------------------------------------------------
    291 */
    292 float128 float128_round_to_int( float128 );
    293 float128 float128_add( float128, float128 );
    294 float128 float128_sub( float128, float128 );
    295 float128 float128_mul( float128, float128 );
    296 float128 float128_div( float128, float128 );
    297 float128 float128_rem( float128, float128 );
    298 float128 float128_sqrt( float128 );
    299 flag float128_eq( float128, float128 );
    300 flag float128_le( float128, float128 );
    301 flag float128_lt( float128, float128 );
    302 flag float128_eq_signaling( float128, float128 );
    303 flag float128_le_quiet( float128, float128 );
    304 flag float128_lt_quiet( float128, float128 );
    305 flag float128_is_signaling_nan( float128 );
    306 
    307 #endif
    308