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