arch/mips/math-emu/ieee754.h

   1 /*
   2  * MIPS floating point support
   3  * Copyright (C) 1994-2000 Algorithmics Ltd.
   4  *
   5  *  This program is free software; you can distribute it and/or modify it
   6  *  under the terms of the GNU General Public License (Version 2) as
   7  *  published by the Free Software Foundation.
   8  *
   9  *  This program is distributed in the hope it will be useful, but WITHOUT
  10  *  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  *  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  *  for more details.
  13  *
  14  *  You should have received a copy of the GNU General Public License along
  15  *  with this program; if not, write to the Free Software Foundation, Inc.,
  16  *  59 Temple Place - Suite 330, Boston MA 02111-1307, USA.
  17  *
  18  *  Nov 7, 2000
  19  *  Modification to allow integration with Linux kernel
  20  *
  21  *  Kevin D. Kissell, kevink@mips.com and Carsten Langgard, carstenl@mips.com
  22  *  Copyright (C) 2000 MIPS Technologies, Inc. All rights reserved.
  23  */
  24 #ifndef __ARCH_MIPS_MATH_EMU_IEEE754_H
  25 #define __ARCH_MIPS_MATH_EMU_IEEE754_H
  26
  27 #include <linux/compiler.h>
  28 #include <asm/byteorder.h>
  29 #include <linux/types.h>
  30 #include <linux/sched.h>
  31 #include <asm/bitfield.h>
  32
  33 /*
  34  * Not very pretty, but the Linux kernel's normal va_list definition
  35  * does not allow it to be used as a structure element, as it is here.
  36  */
  37 #ifndef _STDARG_H
  38 #include <stdarg.h>
  39 #endif
  40
  41 struct ieee754dp_const {
  42         __BITFIELD_FIELD(unsigned sign:1,
  43         __BITFIELD_FIELD(unsigned bexp:11,
  44         __BITFIELD_FIELD(unsigned manthi:20,
  45         __BITFIELD_FIELD(unsigned mantlo:32,
  46         ;))))
  47 };
  48
  49 union ieee754dp {
  50         struct ieee754dp_const oparts;
  51         struct {
  52                 __BITFIELD_FIELD(unsigned int sign:1,
  53                 __BITFIELD_FIELD(unsigned int bexp:11,
  54                 __BITFIELD_FIELD(u64 mant:52,
  55                 ;)))
  56         } parts;
  57         double d;
  58         u64 bits;
  59 };
  60
  61 struct ieee754sp_const {
  62         __BITFIELD_FIELD(unsigned sign:1,
  63         __BITFIELD_FIELD(unsigned bexp:8,
  64         __BITFIELD_FIELD(unsigned mant:23,
  65         ;)))
  66 };
  67
  68 union ieee754sp {
  69         struct ieee754sp_const parts;
  70         float f;
  71         u32 bits;
  72 };
  73
  74 /*
  75  * single precision (often aka float)
  76 */
  77 int ieee754sp_finite(union ieee754sp x);
  78 int ieee754sp_class(union ieee754sp x);
  79
  80 union ieee754sp ieee754sp_abs(union ieee754sp x);
  81 union ieee754sp ieee754sp_neg(union ieee754sp x);
  82 union ieee754sp ieee754sp_scalb(union ieee754sp x, int);
  83 union ieee754sp ieee754sp_logb(union ieee754sp x);
  84
  85 /* x with sign of y */
  86 union ieee754sp ieee754sp_copysign(union ieee754sp x, union ieee754sp y);
  87
  88 union ieee754sp ieee754sp_add(union ieee754sp x, union ieee754sp y);
  89 union ieee754sp ieee754sp_sub(union ieee754sp x, union ieee754sp y);
  90 union ieee754sp ieee754sp_mul(union ieee754sp x, union ieee754sp y);
  91 union ieee754sp ieee754sp_div(union ieee754sp x, union ieee754sp y);
  92
  93 union ieee754sp ieee754sp_fint(int x);
  94 union ieee754sp ieee754sp_funs(unsigned x);
  95 union ieee754sp ieee754sp_flong(s64 x);
  96 union ieee754sp ieee754sp_fulong(u64 x);
  97 union ieee754sp ieee754sp_fdp(union ieee754dp x);
  98
  99 int ieee754sp_tint(union ieee754sp x);
 100 unsigned int ieee754sp_tuns(union ieee754sp x);
 101 s64 ieee754sp_tlong(union ieee754sp x);
 102 u64 ieee754sp_tulong(union ieee754sp x);
 103
 104 int ieee754sp_cmp(union ieee754sp x, union ieee754sp y, int cop, int sig);
 105 /*
 106  * basic sp math
 107  */
 108 union ieee754sp ieee754sp_modf(union ieee754sp x, union ieee754sp * ip);
 109 union ieee754sp ieee754sp_frexp(union ieee754sp x, int *exp);
 110 union ieee754sp ieee754sp_ldexp(union ieee754sp x, int exp);
 111
 112 union ieee754sp ieee754sp_ceil(union ieee754sp x);
 113 union ieee754sp ieee754sp_floor(union ieee754sp x);
 114 union ieee754sp ieee754sp_trunc(union ieee754sp x);
 115
 116 union ieee754sp ieee754sp_sqrt(union ieee754sp x);
 117
 118 /*
 119  * double precision (often aka double)
 120 */
 121 int ieee754dp_finite(union ieee754dp x);
 122 int ieee754dp_class(union ieee754dp x);
 123
 124 /* x with sign of y */
 125 union ieee754dp ieee754dp_copysign(union ieee754dp x, union ieee754dp y);
 126
 127 union ieee754dp ieee754dp_add(union ieee754dp x, union ieee754dp y);
 128 union ieee754dp ieee754dp_sub(union ieee754dp x, union ieee754dp y);
 129 union ieee754dp ieee754dp_mul(union ieee754dp x, union ieee754dp y);
 130 union ieee754dp ieee754dp_div(union ieee754dp x, union ieee754dp y);
 131
 132 union ieee754dp ieee754dp_abs(union ieee754dp x);
 133 union ieee754dp ieee754dp_neg(union ieee754dp x);
 134 union ieee754dp ieee754dp_scalb(union ieee754dp x, int);
 135
 136 /* return exponent as integer in floating point format
 137  */
 138 union ieee754dp ieee754dp_logb(union ieee754dp x);
 139
 140 union ieee754dp ieee754dp_fint(int x);
 141 union ieee754dp ieee754dp_funs(unsigned x);
 142 union ieee754dp ieee754dp_flong(s64 x);
 143 union ieee754dp ieee754dp_fulong(u64 x);
 144 union ieee754dp ieee754dp_fsp(union ieee754sp x);
 145
 146 union ieee754dp ieee754dp_ceil(union ieee754dp x);
 147 union ieee754dp ieee754dp_floor(union ieee754dp x);
 148 union ieee754dp ieee754dp_trunc(union ieee754dp x);
 149
 150 int ieee754dp_tint(union ieee754dp x);
 151 unsigned int ieee754dp_tuns(union ieee754dp x);
 152 s64 ieee754dp_tlong(union ieee754dp x);
 153 u64 ieee754dp_tulong(union ieee754dp x);
 154
 155 int ieee754dp_cmp(union ieee754dp x, union ieee754dp y, int cop, int sig);
 156 /*
 157  * basic sp math
 158  */
 159 union ieee754dp ieee754dp_modf(union ieee754dp x, union ieee754dp * ip);
 160 union ieee754dp ieee754dp_frexp(union ieee754dp x, int *exp);
 161 union ieee754dp ieee754dp_ldexp(union ieee754dp x, int exp);
 162
 163 union ieee754dp ieee754dp_ceil(union ieee754dp x);
 164 union ieee754dp ieee754dp_floor(union ieee754dp x);
 165 union ieee754dp ieee754dp_trunc(union ieee754dp x);
 166
 167 union ieee754dp ieee754dp_sqrt(union ieee754dp x);
 168
 169
 170
 171 /* 5 types of floating point number
 172 */
 173 enum {
 174         IEEE754_CLASS_NORM      = 0x00,
 175         IEEE754_CLASS_ZERO      = 0x01,
 176         IEEE754_CLASS_DNORM     = 0x02,
 177         IEEE754_CLASS_INF       = 0x03,
 178         IEEE754_CLASS_SNAN      = 0x04,
 179         IEEE754_CLASS_QNAN      = 0x05,
 180 };
 181
 182 /* exception numbers */
 183 #define IEEE754_INEXACT                 0x01
 184 #define IEEE754_UNDERFLOW               0x02
 185 #define IEEE754_OVERFLOW                0x04
 186 #define IEEE754_ZERO_DIVIDE             0x08
 187 #define IEEE754_INVALID_OPERATION       0x10
 188
 189 /* cmp operators
 190 */
 191 #define IEEE754_CLT     0x01
 192 #define IEEE754_CEQ     0x02
 193 #define IEEE754_CGT     0x04
 194 #define IEEE754_CUN     0x08
 195
 196 /* rounding mode
 197 */
 198 #define IEEE754_RN      0       /* round to nearest */
 199 #define IEEE754_RZ      1       /* round toward zero  */
 200 #define IEEE754_RD      2       /* round toward -Infinity */
 201 #define IEEE754_RU      3       /* round toward +Infinity */
 202
 203 /* other naming */
 204 #define IEEE754_RM      IEEE754_RD
 205 #define IEEE754_RP      IEEE754_RU
 206
 207 /* "normal" comparisons
 208 */
 209 static inline int ieee754sp_eq(union ieee754sp x, union ieee754sp y)
 210 {
 211         return ieee754sp_cmp(x, y, IEEE754_CEQ, 0);
 212 }
 213
 214 static inline int ieee754sp_ne(union ieee754sp x, union ieee754sp y)
 215 {
 216         return ieee754sp_cmp(x, y,
 217                              IEEE754_CLT | IEEE754_CGT | IEEE754_CUN, 0);
 218 }
 219
 220 static inline int ieee754sp_lt(union ieee754sp x, union ieee754sp y)
 221 {
 222         return ieee754sp_cmp(x, y, IEEE754_CLT, 0);
 223 }
 224
 225 static inline int ieee754sp_le(union ieee754sp x, union ieee754sp y)
 226 {
 227         return ieee754sp_cmp(x, y, IEEE754_CLT | IEEE754_CEQ, 0);
 228 }
 229
 230 static inline int ieee754sp_gt(union ieee754sp x, union ieee754sp y)
 231 {
 232         return ieee754sp_cmp(x, y, IEEE754_CGT, 0);
 233 }
 234
 235
 236 static inline int ieee754sp_ge(union ieee754sp x, union ieee754sp y)
 237 {
 238         return ieee754sp_cmp(x, y, IEEE754_CGT | IEEE754_CEQ, 0);
 239 }
 240
 241 static inline int ieee754dp_eq(union ieee754dp x, union ieee754dp y)
 242 {
 243         return ieee754dp_cmp(x, y, IEEE754_CEQ, 0);
 244 }
 245
 246 static inline int ieee754dp_ne(union ieee754dp x, union ieee754dp y)
 247 {
 248         return ieee754dp_cmp(x, y,
 249                              IEEE754_CLT | IEEE754_CGT | IEEE754_CUN, 0);
 250 }
 251
 252 static inline int ieee754dp_lt(union ieee754dp x, union ieee754dp y)
 253 {
 254         return ieee754dp_cmp(x, y, IEEE754_CLT, 0);
 255 }
 256
 257 static inline int ieee754dp_le(union ieee754dp x, union ieee754dp y)
 258 {
 259         return ieee754dp_cmp(x, y, IEEE754_CLT | IEEE754_CEQ, 0);
 260 }
 261
 262 static inline int ieee754dp_gt(union ieee754dp x, union ieee754dp y)
 263 {
 264         return ieee754dp_cmp(x, y, IEEE754_CGT, 0);
 265 }
 266
 267 static inline int ieee754dp_ge(union ieee754dp x, union ieee754dp y)
 268 {
 269         return ieee754dp_cmp(x, y, IEEE754_CGT | IEEE754_CEQ, 0);
 270 }
 271
 272
 273 /*
 274  * Like strtod
 275  */
 276 union ieee754dp ieee754dp_fstr(const char *s, char **endp);
 277 char *ieee754dp_tstr(union ieee754dp x, int prec, int fmt, int af);
 278
 279
 280 /*
 281  * The control status register
 282  */
 283 struct _ieee754_csr {
 284         __BITFIELD_FIELD(unsigned pad0:7,
 285         __BITFIELD_FIELD(unsigned nod:1,        /* set 1 for no denormalised numbers */
 286         __BITFIELD_FIELD(unsigned c:1,          /* condition */
 287         __BITFIELD_FIELD(unsigned pad1:5,
 288         __BITFIELD_FIELD(unsigned cx:6,         /* exceptions this operation */
 289         __BITFIELD_FIELD(unsigned mx:5,         /* exception enable  mask */
 290         __BITFIELD_FIELD(unsigned sx:5,         /* exceptions total */
 291         __BITFIELD_FIELD(unsigned rm:2,         /* current rounding mode */
 292         ;))))))))
 293 };
 294 #define ieee754_csr (*(struct _ieee754_csr *)(&current->thread.fpu.fcr31))
 295
 296 static inline unsigned ieee754_getrm(void)
 297 {
 298         return (ieee754_csr.rm);
 299 }
 300 static inline unsigned ieee754_setrm(unsigned rm)
 301 {
 302         return (ieee754_csr.rm = rm);
 303 }
 304
 305 /*
 306  * get current exceptions
 307  */
 308 static inline unsigned ieee754_getcx(void)
 309 {
 310         return (ieee754_csr.cx);
 311 }
 312
 313 /* test for current exception condition
 314  */
 315 static inline int ieee754_cxtest(unsigned n)
 316 {
 317         return (ieee754_csr.cx & n);
 318 }
 319
 320 /*
 321  * get sticky exceptions
 322  */
 323 static inline unsigned ieee754_getsx(void)
 324 {
 325         return (ieee754_csr.sx);
 326 }
 327
 328 /* clear sticky conditions
 329 */
 330 static inline unsigned ieee754_clrsx(void)
 331 {
 332         return (ieee754_csr.sx = 0);
 333 }
 334
 335 /* test for sticky exception condition
 336  */
 337 static inline int ieee754_sxtest(unsigned n)
 338 {
 339         return (ieee754_csr.sx & n);
 340 }
 341
 342 /* debugging */
 343 union ieee754sp ieee754sp_dump(char *s, union ieee754sp x);
 344 union ieee754dp ieee754dp_dump(char *s, union ieee754dp x);
 345
 346 #define IEEE754_SPCVAL_PZERO    0
 347 #define IEEE754_SPCVAL_NZERO    1
 348 #define IEEE754_SPCVAL_PONE     2
 349 #define IEEE754_SPCVAL_NONE     3
 350 #define IEEE754_SPCVAL_PTEN     4
 351 #define IEEE754_SPCVAL_NTEN     5
 352 #define IEEE754_SPCVAL_PINFINITY        6
 353 #define IEEE754_SPCVAL_NINFINITY        7
 354 #define IEEE754_SPCVAL_INDEF    8
 355 #define IEEE754_SPCVAL_PMAX     9       /* +max norm */
 356 #define IEEE754_SPCVAL_NMAX     10      /* -max norm */
 357 #define IEEE754_SPCVAL_PMIN     11      /* +min norm */
 358 #define IEEE754_SPCVAL_NMIN     12      /* +min norm */
 359 #define IEEE754_SPCVAL_PMIND    13      /* +min denorm */
 360 #define IEEE754_SPCVAL_NMIND    14      /* +min denorm */
 361 #define IEEE754_SPCVAL_P1E31    15      /* + 1.0e31 */
 362 #define IEEE754_SPCVAL_P1E63    16      /* + 1.0e63 */
 363
 364 extern const struct ieee754dp_const __ieee754dp_spcvals[];
 365 extern const struct ieee754sp_const __ieee754sp_spcvals[];
 366 #define ieee754dp_spcvals ((const union ieee754dp *)__ieee754dp_spcvals)
 367 #define ieee754sp_spcvals ((const union ieee754sp *)__ieee754sp_spcvals)
 368
 369 /*
 370  * Return infinity with given sign
 371  */
 372 #define ieee754dp_inf(sn)     (ieee754dp_spcvals[IEEE754_SPCVAL_PINFINITY+(sn)])
 373 #define ieee754dp_zero(sn)      (ieee754dp_spcvals[IEEE754_SPCVAL_PZERO+(sn)])
 374 #define ieee754dp_one(sn)       (ieee754dp_spcvals[IEEE754_SPCVAL_PONE+(sn)])
 375 #define ieee754dp_ten(sn)       (ieee754dp_spcvals[IEEE754_SPCVAL_PTEN+(sn)])
 376 #define ieee754dp_indef()       (ieee754dp_spcvals[IEEE754_SPCVAL_INDEF])
 377 #define ieee754dp_max(sn)       (ieee754dp_spcvals[IEEE754_SPCVAL_PMAX+(sn)])
 378 #define ieee754dp_min(sn)       (ieee754dp_spcvals[IEEE754_SPCVAL_PMIN+(sn)])
 379 #define ieee754dp_mind(sn)      (ieee754dp_spcvals[IEEE754_SPCVAL_PMIND+(sn)])
 380 #define ieee754dp_1e31()        (ieee754dp_spcvals[IEEE754_SPCVAL_P1E31])
 381 #define ieee754dp_1e63()        (ieee754dp_spcvals[IEEE754_SPCVAL_P1E63])
 382
 383 #define ieee754sp_inf(sn)     (ieee754sp_spcvals[IEEE754_SPCVAL_PINFINITY+(sn)])
 384 #define ieee754sp_zero(sn)      (ieee754sp_spcvals[IEEE754_SPCVAL_PZERO+(sn)])
 385 #define ieee754sp_one(sn)       (ieee754sp_spcvals[IEEE754_SPCVAL_PONE+(sn)])
 386 #define ieee754sp_ten(sn)       (ieee754sp_spcvals[IEEE754_SPCVAL_PTEN+(sn)])
 387 #define ieee754sp_indef()       (ieee754sp_spcvals[IEEE754_SPCVAL_INDEF])
 388 #define ieee754sp_max(sn)       (ieee754sp_spcvals[IEEE754_SPCVAL_PMAX+(sn)])
 389 #define ieee754sp_min(sn)       (ieee754sp_spcvals[IEEE754_SPCVAL_PMIN+(sn)])
 390 #define ieee754sp_mind(sn)      (ieee754sp_spcvals[IEEE754_SPCVAL_PMIND+(sn)])
 391 #define ieee754sp_1e31()        (ieee754sp_spcvals[IEEE754_SPCVAL_P1E31])
 392 #define ieee754sp_1e63()        (ieee754sp_spcvals[IEEE754_SPCVAL_P1E63])
 393
 394 /*
 395  * Indefinite integer value
 396  */
 397 #define ieee754si_indef()       INT_MAX
 398 #ifdef LONG_LONG_MAX
 399 #define ieee754di_indef()       LONG_LONG_MAX
 400 #else
 401 #define ieee754di_indef()       ((s64)(~0ULL>>1))
 402 #endif
 403
 404 /* IEEE exception context, passed to handler */
 405 struct ieee754xctx {
 406         const char *op;         /* operation name */
 407         int rt;                 /* result type */
 408         union {
 409                 union ieee754sp sp;     /* single precision */
 410                 union ieee754dp dp;     /* double precision */
 411                 int si;         /* standard signed integer (32bits) */
 412                 s64 di;         /* extended signed integer (64bits) */
 413         } rv;                   /* default result format implied by op */
 414         va_list ap;
 415 };
 416
 417 /* result types for xctx.rt */
 418 #define IEEE754_RT_SP   0
 419 #define IEEE754_RT_DP   1
 420 #define IEEE754_RT_XP   2
 421 #define IEEE754_RT_SI   3
 422 #define IEEE754_RT_DI   4
 423
 424 extern void __cold ieee754_xcpt(struct ieee754xctx *xcp);
 425
 426 /* compat */
 427 #define ieee754dp_fix(x)        ieee754dp_tint(x)
 428 #define ieee754sp_fix(x)        ieee754sp_tint(x)
 429
 430 #endif /* __ARCH_MIPS_MATH_EMU_IEEE754_H */