Home | History | Annotate | Line # | Download | only in softfloat
softfloat.h revision 1.8
      1 /*	$NetBSD: softfloat.h,v 1.8 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 int 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 #ifndef SOFTFLOAT_FOR_GCC /* __floatdi?f is in libgcc2.c */
    135 float32 int64_to_float32( long long );
    136 float64 int64_to_float64( long long );
    137 #ifdef FLOATX80
    138 floatx80 int64_to_floatx80( long long );
    139 #endif
    140 #ifdef FLOAT128
    141 float128 int64_to_float128( long long );
    142 #endif
    143 #endif
    144 
    145 /*
    146 -------------------------------------------------------------------------------
    147 Software IEC/IEEE single-precision conversion routines.
    148 -------------------------------------------------------------------------------
    149 */
    150 int float32_to_int32( float32 );
    151 int float32_to_int32_round_to_zero( float32 );
    152 #if defined(SOFTFLOAT_FOR_GCC) && defined(SOFTFLOAT_NEED_FIXUNS)
    153 unsigned int float32_to_uint32_round_to_zero( float32 );
    154 #endif
    155 #ifndef SOFTFLOAT_FOR_GCC /* __fix?fdi provided by libgcc2.c */
    156 long long float32_to_int64( float32 );
    157 long long float32_to_int64_round_to_zero( float32 );
    158 #endif
    159 float64 float32_to_float64( float32 );
    160 #ifdef FLOATX80
    161 floatx80 float32_to_floatx80( float32 );
    162 #endif
    163 #ifdef FLOAT128
    164 float128 float32_to_float128( float32 );
    165 #endif
    166 
    167 /*
    168 -------------------------------------------------------------------------------
    169 Software IEC/IEEE single-precision operations.
    170 -------------------------------------------------------------------------------
    171 */
    172 float32 float32_round_to_int( float32 );
    173 float32 float32_add( float32, float32 );
    174 float32 float32_sub( float32, float32 );
    175 float32 float32_mul( float32, float32 );
    176 float32 float32_div( float32, float32 );
    177 float32 float32_rem( float32, float32 );
    178 float32 float32_sqrt( float32 );
    179 int float32_eq( float32, float32 );
    180 int float32_le( float32, float32 );
    181 int float32_lt( float32, float32 );
    182 int float32_eq_signaling( float32, float32 );
    183 int float32_le_quiet( float32, float32 );
    184 int float32_lt_quiet( float32, float32 );
    185 #ifndef SOFTFLOAT_FOR_GCC
    186 int float32_is_signaling_nan( float32 );
    187 #endif
    188 
    189 /*
    190 -------------------------------------------------------------------------------
    191 Software IEC/IEEE double-precision conversion routines.
    192 -------------------------------------------------------------------------------
    193 */
    194 int float64_to_int32( float64 );
    195 int float64_to_int32_round_to_zero( float64 );
    196 #if defined(SOFTFLOAT_FOR_GCC) && defined(SOFTFLOAT_NEED_FIXUNS)
    197 unsigned int float64_to_uint32_round_to_zero( float64 );
    198 #endif
    199 #ifndef SOFTFLOAT_FOR_GCC /* __fix?fdi provided by libgcc2.c */
    200 long long float64_to_int64( float64 );
    201 long long float64_to_int64_round_to_zero( float64 );
    202 #endif
    203 float32 float64_to_float32( float64 );
    204 #ifdef FLOATX80
    205 floatx80 float64_to_floatx80( float64 );
    206 #endif
    207 #ifdef FLOAT128
    208 float128 float64_to_float128( float64 );
    209 #endif
    210 
    211 /*
    212 -------------------------------------------------------------------------------
    213 Software IEC/IEEE double-precision operations.
    214 -------------------------------------------------------------------------------
    215 */
    216 float64 float64_round_to_int( float64 );
    217 float64 float64_add( float64, float64 );
    218 float64 float64_sub( float64, float64 );
    219 float64 float64_mul( float64, float64 );
    220 float64 float64_div( float64, float64 );
    221 float64 float64_rem( float64, float64 );
    222 float64 float64_sqrt( float64 );
    223 int float64_eq( float64, float64 );
    224 int float64_le( float64, float64 );
    225 int float64_lt( float64, float64 );
    226 int float64_eq_signaling( float64, float64 );
    227 int float64_le_quiet( float64, float64 );
    228 int float64_lt_quiet( float64, float64 );
    229 #ifndef SOFTFLOAT_FOR_GCC
    230 int float64_is_signaling_nan( float64 );
    231 #endif
    232 
    233 #ifdef FLOATX80
    234 
    235 /*
    236 -------------------------------------------------------------------------------
    237 Software IEC/IEEE extended double-precision conversion routines.
    238 -------------------------------------------------------------------------------
    239 */
    240 int floatx80_to_int32( floatx80 );
    241 int floatx80_to_int32_round_to_zero( floatx80 );
    242 long long floatx80_to_int64( floatx80 );
    243 long long floatx80_to_int64_round_to_zero( floatx80 );
    244 float32 floatx80_to_float32( floatx80 );
    245 float64 floatx80_to_float64( floatx80 );
    246 #ifdef FLOAT128
    247 float128 floatx80_to_float128( floatx80 );
    248 #endif
    249 
    250 /*
    251 -------------------------------------------------------------------------------
    252 Software IEC/IEEE extended double-precision rounding precision.  Valid
    253 values are 32, 64, and 80.
    254 -------------------------------------------------------------------------------
    255 */
    256 extern int floatx80_rounding_precision;
    257 
    258 /*
    259 -------------------------------------------------------------------------------
    260 Software IEC/IEEE extended double-precision operations.
    261 -------------------------------------------------------------------------------
    262 */
    263 floatx80 floatx80_round_to_int( floatx80 );
    264 floatx80 floatx80_add( floatx80, floatx80 );
    265 floatx80 floatx80_sub( floatx80, floatx80 );
    266 floatx80 floatx80_mul( floatx80, floatx80 );
    267 floatx80 floatx80_div( floatx80, floatx80 );
    268 floatx80 floatx80_rem( floatx80, floatx80 );
    269 floatx80 floatx80_sqrt( floatx80 );
    270 int floatx80_eq( floatx80, floatx80 );
    271 int floatx80_le( floatx80, floatx80 );
    272 int floatx80_lt( floatx80, floatx80 );
    273 int floatx80_eq_signaling( floatx80, floatx80 );
    274 int floatx80_le_quiet( floatx80, floatx80 );
    275 int floatx80_lt_quiet( floatx80, floatx80 );
    276 int floatx80_is_signaling_nan( floatx80 );
    277 
    278 #endif
    279 
    280 #ifdef FLOAT128
    281 
    282 /*
    283 -------------------------------------------------------------------------------
    284 Software IEC/IEEE quadruple-precision conversion routines.
    285 -------------------------------------------------------------------------------
    286 */
    287 int float128_to_int32( float128 );
    288 int float128_to_int32_round_to_zero( float128 );
    289 long long float128_to_int64( float128 );
    290 long long float128_to_int64_round_to_zero( float128 );
    291 float32 float128_to_float32( float128 );
    292 float64 float128_to_float64( float128 );
    293 #ifdef FLOATX80
    294 floatx80 float128_to_floatx80( float128 );
    295 #endif
    296 
    297 /*
    298 -------------------------------------------------------------------------------
    299 Software IEC/IEEE quadruple-precision operations.
    300 -------------------------------------------------------------------------------
    301 */
    302 float128 float128_round_to_int( float128 );
    303 float128 float128_add( float128, float128 );
    304 float128 float128_sub( float128, float128 );
    305 float128 float128_mul( float128, float128 );
    306 float128 float128_div( float128, float128 );
    307 float128 float128_rem( float128, float128 );
    308 float128 float128_sqrt( float128 );
    309 int float128_eq( float128, float128 );
    310 int float128_le( float128, float128 );
    311 int float128_lt( float128, float128 );
    312 int float128_eq_signaling( float128, float128 );
    313 int float128_le_quiet( float128, float128 );
    314 int float128_lt_quiet( float128, float128 );
    315 int float128_is_signaling_nan( float128 );
    316 
    317 #endif
    318 
    319