libdecnumber/decNumberLocal.h

   1 /* Local definitions for the decNumber C Library.
   2    Copyright (C) 2007 Free Software Foundation, Inc.
   3    Contributed by IBM Corporation.  Author Mike Cowlishaw.
   4
   5    This file is part of GCC.
   6
   7    GCC is free software; you can redistribute it and/or modify it under
   8    the terms of the GNU General Public License as published by the Free
   9    Software Foundation; either version 2, or (at your option) any later
  10    version.
  11
  12    In addition to the permissions in the GNU General Public License,
  13    the Free Software Foundation gives you unlimited permission to link
  14    the compiled version of this file into combinations with other
  15    programs, and to distribute those combinations without any
  16    restriction coming from the use of this file.  (The General Public
  17    License restrictions do apply in other respects; for example, they
  18    cover modification of the file, and distribution when not linked
  19    into a combine executable.)
  20
  21    GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  22    WARRANTY; without even the implied warranty of MERCHANTABILITY or
  23    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  24    for more details.
  25
  26    You should have received a copy of the GNU General Public License
  27    along with GCC; see the file COPYING.  If not, write to the Free
  28    Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA
  29    02110-1301, USA.  */
  30
  31 /* ------------------------------------------------------------------ */
  32 /* decNumber package local type, tuning, and macro definitions        */
  33 /* ------------------------------------------------------------------ */
  34 /* This header file is included by all modules in the decNumber       */
  35 /* library, and contains local type definitions, tuning parameters,   */
  36 /* etc.  It should not need to be used by application programs.       */
  37 /* decNumber.h or one of decDouble (etc.) must be included first.     */
  38 /* ------------------------------------------------------------------ */
  39
  40 #if !defined(DECNUMBERLOC)
  41   #define DECNUMBERLOC
  42   #define DECVERSION    "decNumber 3.53" /* Package Version [16 max.] */
  43   #define DECNLAUTHOR   "Mike Cowlishaw"              /* Who to blame */
  44
  45   #include <stdlib.h>         /* for abs                              */
  46   #include <string.h>         /* for memset, strcpy                   */
  47   #include "dconfig.h"        /* for WORDS_BIGENDIAN                  */
  48
  49   /* Conditional code flag -- set this to match hardware platform     */
  50   /* 1=little-endian, 0=big-endian                                    */
  51   #if WORDS_BIGENDIAN
  52   #define DECLITEND 0
  53   #else
  54   #define DECLITEND 1
  55   #endif
  56
  57   /* Conditional code flag -- set this to 1 for best performance      */
  58   #define DECUSE64  1         /* 1=use int64s, 0=int32 & smaller only */
  59
  60   /* Conditional check flags -- set these to 0 for best performance   */
  61   #define DECCHECK  0         /* 1 to enable robust checking          */
  62   #define DECALLOC  0         /* 1 to enable memory accounting        */
  63   #define DECTRACE  0         /* 1 to trace certain internals, etc.   */
  64
  65   /* Tuning parameter for decNumber (arbitrary precision) module      */
  66   #define DECBUFFER 36        /* Size basis for local buffers.  This  */
  67                               /* should be a common maximum precision */
  68                               /* rounded up to a multiple of 4; must  */
  69                               /* be zero or positive.                 */
  70
  71   /* ---------------------------------------------------------------- */
  72   /* Definitions for all modules (general-purpose)                    */
  73   /* ---------------------------------------------------------------- */
  74
  75   /* Local names for common types -- for safety, decNumber modules do */
  76   /* not use int or long directly.                                    */
  77   #define Flag   uint8_t
  78   #define Byte   int8_t
  79   #define uByte  uint8_t
  80   #define Short  int16_t
  81   #define uShort uint16_t
  82   #define Int    int32_t
  83   #define uInt   uint32_t
  84   #define Unit   decNumberUnit
  85   #if DECUSE64
  86   #define Long   int64_t
  87   #define uLong  uint64_t
  88   #endif
  89
  90   /* Development-use definitions                                      */
  91   typedef long int LI;        /* for printf arguments only            */
  92   #define DECNOINT  0         /* 1 to check no internal use of 'int'  */
  93   #if DECNOINT
  94     /* if these interfere with your C includes, do not set DECNOINT   */
  95     #define  int ?            /* enable to ensure that plain C 'int'  */
  96     #define  long ??          /* .. or 'long' types are not used      */
  97   #endif
  98
  99   /* Shared lookup tables                                             */
 100   extern const uByte  DECSTICKYTAB[10]; /* re-round digits if sticky  */
 101   extern const uInt   DECPOWERS[10];    /* powers of ten table        */
 102   /* The following are included from decDPD.h                         */
 103 #include "decDPDSymbols.h"
 104   extern const uShort DPD2BIN[1024];    /* DPD -> 0-999               */
 105   extern const uShort BIN2DPD[1000];    /* 0-999 -> DPD               */
 106   extern const uInt   DPD2BINK[1024];   /* DPD -> 0-999000            */
 107   extern const uInt   DPD2BINM[1024];   /* DPD -> 0-999000000         */
 108   extern const uByte  DPD2BCD8[4096];   /* DPD -> ddd + len           */
 109   extern const uByte  BIN2BCD8[4000];   /* 0-999 -> ddd + len         */
 110   extern const uShort BCD2DPD[2458];    /* 0-0x999 -> DPD (0x999=2457)*/
 111
 112   /* LONGMUL32HI -- set w=(u*v)>>32, where w, u, and v are uInts      */
 113   /* (that is, sets w to be the high-order word of the 64-bit result; */
 114   /* the low-order word is simply u*v.)                               */
 115   /* This version is derived from Knuth via Hacker's Delight;         */
 116   /* it seems to optimize better than some others tried               */
 117   #define LONGMUL32HI(w, u, v) {             \
 118     uInt u0, u1, v0, v1, w0, w1, w2, t;      \
 119     u0=u & 0xffff; u1=u>>16;                 \
 120     v0=v & 0xffff; v1=v>>16;                 \
 121     w0=u0*v0;                                \
 122     t=u1*v0 + (w0>>16);                      \
 123     w1=t & 0xffff; w2=t>>16;                 \
 124     w1=u0*v1 + w1;                           \
 125     (w)=u1*v1 + w2 + (w1>>16);}
 126
 127   /* ROUNDUP -- round an integer up to a multiple of n                */
 128   #define ROUNDUP(i, n) ((((i)+(n)-1)/n)*n)
 129
 130   /* ROUNDDOWN -- round an integer down to a multiple of n            */
 131   #define ROUNDDOWN(i, n) (((i)/n)*n)
 132   #define ROUNDDOWN4(i)   ((i)&~3)      /* special for n=4            */
 133
 134   /* References to multi-byte sequences under different sizes         */
 135   /* Refer to a uInt from four bytes starting at a char* or uByte*,   */
 136   /* etc.                                                             */
 137   #define UINTAT(b)   (*((uInt   *)(b)))
 138   #define USHORTAT(b) (*((uShort *)(b)))
 139   #define UBYTEAT(b)  (*((uByte  *)(b)))
 140
 141   /* X10 and X100 -- multiply integer i by 10 or 100                  */
 142   /* [shifts are usually faster than multiply; could be conditional]  */
 143   #define X10(i)  (((i)<<1)+((i)<<3))
 144   #define X100(i) (((i)<<2)+((i)<<5)+((i)<<6))
 145
 146   /* MAXI and MINI -- general max & min (not in ANSI) for integers    */
 147   #define MAXI(x,y) ((x)<(y)?(y):(x))
 148   #define MINI(x,y) ((x)>(y)?(y):(x))
 149
 150   /* Useful constants                                                 */
 151   #define BILLION      1000000000            /* 10**9                 */
 152   /* CHARMASK: 0x30303030 for ASCII/UTF8; 0xF0F0F0F0 for EBCDIC       */
 153   #define CHARMASK ((((((((uInt)'0')<<8)+'0')<<8)+'0')<<8)+'0')
 154
 155
 156   /* ---------------------------------------------------------------- */
 157   /* Definitions for arbitary-precision modules (only valid after     */
 158   /* decNumber.h has been included)                                   */
 159   /* ---------------------------------------------------------------- */
 160
 161   /* Limits and constants                                             */
 162   #define DECNUMMAXP 999999999  /* maximum precision code can handle  */
 163   #define DECNUMMAXE 999999999  /* maximum adjusted exponent ditto    */
 164   #define DECNUMMINE -999999999 /* minimum adjusted exponent ditto    */
 165   #if (DECNUMMAXP != DEC_MAX_DIGITS)
 166     #error Maximum digits mismatch
 167   #endif
 168   #if (DECNUMMAXE != DEC_MAX_EMAX)
 169     #error Maximum exponent mismatch
 170   #endif
 171   #if (DECNUMMINE != DEC_MIN_EMIN)
 172     #error Minimum exponent mismatch
 173   #endif
 174
 175   /* Set DECDPUNMAX -- the maximum integer that fits in DECDPUN       */
 176   /* digits, and D2UTABLE -- the initializer for the D2U table        */
 177   #if   DECDPUN==1
 178     #define DECDPUNMAX 9
 179     #define D2UTABLE {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,  \
 180                       18,19,20,21,22,23,24,25,26,27,28,29,30,31,32, \
 181                       33,34,35,36,37,38,39,40,41,42,43,44,45,46,47, \
 182                       48,49}
 183   #elif DECDPUN==2
 184     #define DECDPUNMAX 99
 185     #define D2UTABLE {0,1,1,2,2,3,3,4,4,5,5,6,6,7,7,8,8,9,9,10,10,  \
 186                       11,11,12,12,13,13,14,14,15,15,16,16,17,17,18, \
 187                       18,19,19,20,20,21,21,22,22,23,23,24,24,25}
 188   #elif DECDPUN==3
 189     #define DECDPUNMAX 999
 190     #define D2UTABLE {0,1,1,1,2,2,2,3,3,3,4,4,4,5,5,5,6,6,6,7,7,7,  \
 191                       8,8,8,9,9,9,10,10,10,11,11,11,12,12,12,13,13, \
 192                       13,14,14,14,15,15,15,16,16,16,17}
 193   #elif DECDPUN==4
 194     #define DECDPUNMAX 9999
 195     #define D2UTABLE {0,1,1,1,1,2,2,2,2,3,3,3,3,4,4,4,4,5,5,5,5,6,  \
 196                       6,6,6,7,7,7,7,8,8,8,8,9,9,9,9,10,10,10,10,11, \
 197                       11,11,11,12,12,12,12,13}
 198   #elif DECDPUN==5
 199     #define DECDPUNMAX 99999
 200     #define D2UTABLE {0,1,1,1,1,1,2,2,2,2,2,3,3,3,3,3,4,4,4,4,4,5,  \
 201                       5,5,5,5,6,6,6,6,6,7,7,7,7,7,8,8,8,8,8,9,9,9,  \
 202                       9,9,10,10,10,10}
 203   #elif DECDPUN==6
 204     #define DECDPUNMAX 999999
 205     #define D2UTABLE {0,1,1,1,1,1,1,2,2,2,2,2,2,3,3,3,3,3,3,4,4,4,  \
 206                       4,4,4,5,5,5,5,5,5,6,6,6,6,6,6,7,7,7,7,7,7,8,  \
 207                       8,8,8,8,8,9}
 208   #elif DECDPUN==7
 209     #define DECDPUNMAX 9999999
 210     #define D2UTABLE {0,1,1,1,1,1,1,1,2,2,2,2,2,2,2,3,3,3,3,3,3,3,  \
 211                       4,4,4,4,4,4,4,5,5,5,5,5,5,5,6,6,6,6,6,6,6,7,  \
 212                       7,7,7,7,7,7}
 213   #elif DECDPUN==8
 214     #define DECDPUNMAX 99999999
 215     #define D2UTABLE {0,1,1,1,1,1,1,1,1,2,2,2,2,2,2,2,2,3,3,3,3,3,  \
 216                       3,3,3,4,4,4,4,4,4,4,4,5,5,5,5,5,5,5,5,6,6,6,  \
 217                       6,6,6,6,6,7}
 218   #elif DECDPUN==9
 219     #define DECDPUNMAX 999999999
 220     #define D2UTABLE {0,1,1,1,1,1,1,1,1,1,2,2,2,2,2,2,2,2,2,3,3,3,  \
 221                       3,3,3,3,3,3,4,4,4,4,4,4,4,4,4,5,5,5,5,5,5,5,  \
 222                       5,5,6,6,6,6}
 223   #elif defined(DECDPUN)
 224     #error DECDPUN must be in the range 1-9
 225   #endif
 226
 227   /* ----- Shared data (in decNumber.c) ----- */
 228   /* Public lookup table used by the D2U macro (see below)            */
 229   #define DECMAXD2U 49
 230   extern const uByte d2utable[DECMAXD2U+1];
 231
 232   /* ----- Macros ----- */
 233   /* ISZERO -- return true if decNumber dn is a zero                  */
 234   /* [performance-critical in some situations]                        */
 235   #define ISZERO(dn) decNumberIsZero(dn)     /* now just a local name */
 236
 237   /* D2U -- return the number of Units needed to hold d digits        */
 238   /* (runtime version, with table lookaside for small d)              */
 239   #if DECDPUN==8
 240     #define D2U(d) ((unsigned)((d)<=DECMAXD2U?d2utable[d]:((d)+7)>>3))
 241   #elif DECDPUN==4
 242     #define D2U(d) ((unsigned)((d)<=DECMAXD2U?d2utable[d]:((d)+3)>>2))
 243   #else
 244     #define D2U(d) ((d)<=DECMAXD2U?d2utable[d]:((d)+DECDPUN-1)/DECDPUN)
 245   #endif
 246   /* SD2U -- static D2U macro (for compile-time calculation)          */
 247   #define SD2U(d) (((d)+DECDPUN-1)/DECDPUN)
 248
 249   /* MSUDIGITS -- returns digits in msu, from digits, calculated      */
 250   /* using D2U                                                        */
 251   #define MSUDIGITS(d) ((d)-(D2U(d)-1)*DECDPUN)
 252
 253   /* D2N -- return the number of decNumber structs that would be      */
 254   /* needed to contain that number of digits (and the initial         */
 255   /* decNumber struct) safely.  Note that one Unit is included in the */
 256   /* initial structure.  Used for allocating space that is aligned on */
 257   /* a decNumber struct boundary. */
 258   #define D2N(d) \
 259     ((((SD2U(d)-1)*sizeof(Unit))+sizeof(decNumber)*2-1)/sizeof(decNumber))
 260
 261   /* TODIGIT -- macro to remove the leading digit from the unsigned   */
 262   /* integer u at column cut (counting from the right, LSD=0) and     */
 263   /* place it as an ASCII character into the character pointed to by  */
 264   /* c.  Note that cut must be <= 9, and the maximum value for u is   */
 265   /* 2,000,000,000 (as is needed for negative exponents of            */
 266   /* subnormals).  The unsigned integer pow is used as a temporary    */
 267   /* variable. */
 268   #define TODIGIT(u, cut, c, pow) {       \
 269     *(c)='0';                             \
 270     pow=DECPOWERS[cut]*2;                 \
 271     if ((u)>pow) {                        \
 272       pow*=4;                             \
 273       if ((u)>=pow) {(u)-=pow; *(c)+=8;}  \
 274       pow/=2;                             \
 275       if ((u)>=pow) {(u)-=pow; *(c)+=4;}  \
 276       pow/=2;                             \
 277       }                                   \
 278     if ((u)>=pow) {(u)-=pow; *(c)+=2;}    \
 279     pow/=2;                               \
 280     if ((u)>=pow) {(u)-=pow; *(c)+=1;}    \
 281     }
 282
 283   /* ---------------------------------------------------------------- */
 284   /* Definitions for fixed-precision modules (only valid after        */
 285   /* decSingle.h, decDouble.h, or decQuad.h has been included)        */
 286   /* ---------------------------------------------------------------- */
 287
 288   /* bcdnum -- a structure describing a format-independent finite     */
 289   /* number, whose coefficient is a string of bcd8 uBytes             */
 290   typedef struct {
 291     uByte   *msd;             /* -> most significant digit            */
 292     uByte   *lsd;             /* -> least ditto                       */
 293     uInt     sign;            /* 0=positive, DECFLOAT_Sign=negative   */
 294     Int      exponent;        /* Unadjusted signed exponent (q), or   */
 295                               /* DECFLOAT_NaN etc. for a special      */
 296     } bcdnum;
 297
 298   /* Test if exponent or bcdnum exponent must be a special, etc.      */
 299   #define EXPISSPECIAL(exp) ((exp)>=DECFLOAT_MinSp)
 300   #define EXPISINF(exp) (exp==DECFLOAT_Inf)
 301   #define EXPISNAN(exp) (exp==DECFLOAT_qNaN || exp==DECFLOAT_sNaN)
 302   #define NUMISSPECIAL(num) (EXPISSPECIAL((num)->exponent))
 303
 304   /* Refer to a 32-bit word or byte in a decFloat (df) by big-endian  */
 305   /* (array) notation (the 0 word or byte contains the sign bit),     */
 306   /* automatically adjusting for endianness; similarly address a word */
 307   /* in the next-wider format (decFloatWider, or dfw)                 */
 308   #define DECWORDS  (DECBYTES/4)
 309   #define DECWWORDS (DECWBYTES/4)
 310   #if DECLITEND
 311     #define DFWORD(df, off) UINTAT((df)->bytes+(DECWORDS-1-(off))*4)
 312     #define DFBYTE(df, off) UBYTEAT((df)->bytes+(DECBYTES-1-(off)))
 313     #define DFWWORD(dfw, off) UINTAT((dfw)->bytes+(DECWWORDS-1-(off))*4)
 314   #else
 315     #define DFWORD(df, off) UINTAT((df)->bytes+(off)*4)
 316     #define DFBYTE(df, off) UBYTEAT((df)->bytes+(off))
 317     #define DFWWORD(dfw, off) UINTAT((dfw)->bytes+(off)*4)
 318   #endif
 319
 320   /* Tests for sign or specials, directly on DECFLOATs                */
 321   #define DFISSIGNED(df)   (DFWORD(df, 0)&0x80000000)
 322   #define DFISSPECIAL(df) ((DFWORD(df, 0)&0x78000000)==0x78000000)
 323   #define DFISINF(df)     ((DFWORD(df, 0)&0x7c000000)==0x78000000)
 324   #define DFISNAN(df)     ((DFWORD(df, 0)&0x7c000000)==0x7c000000)
 325   #define DFISQNAN(df)    ((DFWORD(df, 0)&0x7e000000)==0x7c000000)
 326   #define DFISSNAN(df)    ((DFWORD(df, 0)&0x7e000000)==0x7e000000)
 327
 328   /* Shared lookup tables                                             */
 329 #include "decCommonSymbols.h"
 330   extern const uInt   DECCOMBMSD[64];   /* Combination field -> MSD   */
 331   extern const uInt   DECCOMBFROM[48];  /* exp+msd -> Combination     */
 332
 333   /* Private generic (utility) routine                                */
 334   #if DECCHECK || DECTRACE
 335     extern void decShowNum(const bcdnum *, const char *);
 336   #endif
 337
 338   /* Format-dependent macros and constants                            */
 339   #if defined(DECPMAX)
 340
 341     /* Useful constants                                               */
 342     #define DECPMAX9  (ROUNDUP(DECPMAX, 9)/9)  /* 'Pmax' in 10**9s    */
 343     /* Top words for a zero                                           */
 344     #define SINGLEZERO   0x22500000
 345     #define DOUBLEZERO   0x22380000
 346     #define QUADZERO     0x22080000
 347     /* [ZEROWORD is defined to be one of these in the DFISZERO macro] */
 348
 349     /* Format-dependent common tests:                                 */
 350     /*   DFISZERO   -- test for (any) zero                            */
 351     /*   DFISCCZERO -- test for coefficient continuation being zero   */
 352     /*   DFISCC01   -- test for coefficient contains only 0s and 1s   */
 353     /*   DFISINT    -- test for finite and exponent q=0               */
 354     /*   DFISUINT01 -- test for sign=0, finite, exponent q=0, and     */
 355     /*                 MSD=0 or 1                                     */
 356     /*   ZEROWORD is also defined here.                               */
 357     /* In DFISZERO the first test checks the least-significant word   */
 358     /* (most likely to be non-zero); the penultimate tests MSD and    */
 359     /* DPDs in the signword, and the final test excludes specials and */
 360     /* MSD>7.  DFISINT similarly has to allow for the two forms of    */
 361     /* MSD codes.  DFISUINT01 only has to allow for one form of MSD   */
 362     /* code.                                                          */
 363     #if DECPMAX==7
 364       #define ZEROWORD SINGLEZERO
 365       /* [test macros not needed except for Zero]                     */
 366       #define DFISZERO(df)  ((DFWORD(df, 0)&0x1c0fffff)==0         \
 367                           && (DFWORD(df, 0)&0x60000000)!=0x60000000)
 368     #elif DECPMAX==16
 369       #define ZEROWORD DOUBLEZERO
 370       #define DFISZERO(df)  ((DFWORD(df, 1)==0                     \
 371                           && (DFWORD(df, 0)&0x1c03ffff)==0         \
 372                           && (DFWORD(df, 0)&0x60000000)!=0x60000000))
 373       #define DFISINT(df) ((DFWORD(df, 0)&0x63fc0000)==0x22380000  \
 374                          ||(DFWORD(df, 0)&0x7bfc0000)==0x6a380000)
 375       #define DFISUINT01(df) ((DFWORD(df, 0)&0xfbfc0000)==0x22380000)
 376       #define DFISCCZERO(df) (DFWORD(df, 1)==0                     \
 377                           && (DFWORD(df, 0)&0x0003ffff)==0)
 378       #define DFISCC01(df)  ((DFWORD(df, 0)&~0xfffc9124)==0        \
 379                           && (DFWORD(df, 1)&~0x49124491)==0)
 380     #elif DECPMAX==34
 381       #define ZEROWORD QUADZERO
 382       #define DFISZERO(df)  ((DFWORD(df, 3)==0                     \
 383                           &&  DFWORD(df, 2)==0                     \
 384                           &&  DFWORD(df, 1)==0                     \
 385                           && (DFWORD(df, 0)&0x1c003fff)==0         \
 386                           && (DFWORD(df, 0)&0x60000000)!=0x60000000))
 387       #define DFISINT(df) ((DFWORD(df, 0)&0x63ffc000)==0x22080000  \
 388                          ||(DFWORD(df, 0)&0x7bffc000)==0x6a080000)
 389       #define DFISUINT01(df) ((DFWORD(df, 0)&0xfbffc000)==0x22080000)
 390       #define DFISCCZERO(df) (DFWORD(df, 3)==0                     \
 391                           &&  DFWORD(df, 2)==0                     \
 392                           &&  DFWORD(df, 1)==0                     \
 393                           && (DFWORD(df, 0)&0x00003fff)==0)
 394
 395       #define DFISCC01(df)   ((DFWORD(df, 0)&~0xffffc912)==0       \
 396                           &&  (DFWORD(df, 1)&~0x44912449)==0       \
 397                           &&  (DFWORD(df, 2)&~0x12449124)==0       \
 398                           &&  (DFWORD(df, 3)&~0x49124491)==0)
 399     #endif
 400
 401     /* Macros to test if a certain 10 bits of a uInt or pair of uInts */
 402     /* are a canonical declet [higher or lower bits are ignored].     */
 403     /* declet is at offset 0 (from the right) in a uInt:              */
 404     #define CANONDPD(dpd) (((dpd)&0x300)==0 || ((dpd)&0x6e)!=0x6e)
 405     /* declet is at offset k (a multiple of 2) in a uInt:             */
 406     #define CANONDPDOFF(dpd, k) (((dpd)&(0x300<<(k)))==0            \
 407       || ((dpd)&(((uInt)0x6e)<<(k)))!=(((uInt)0x6e)<<(k)))
 408     /* declet is at offset k (a multiple of 2) in a pair of uInts:    */
 409     /* [the top 2 bits will always be in the more-significant uInt]   */
 410     #define CANONDPDTWO(hi, lo, k) (((hi)&(0x300>>(32-(k))))==0     \
 411       || ((hi)&(0x6e>>(32-(k))))!=(0x6e>>(32-(k)))                  \
 412       || ((lo)&(((uInt)0x6e)<<(k)))!=(((uInt)0x6e)<<(k)))
 413
 414     /* Macro to test whether a full-length (length DECPMAX) BCD8      */
 415     /* coefficient is zero                                            */
 416     /* test just the LSWord first, then the remainder                 */
 417     #if DECPMAX==7
 418       #define ISCOEFFZERO(u) (UINTAT((u)+DECPMAX-4)==0              \
 419         && UINTAT((u)+DECPMAX-7)==0)
 420     #elif DECPMAX==16
 421       #define ISCOEFFZERO(u) (UINTAT((u)+DECPMAX-4)==0              \
 422         && (UINTAT((u)+DECPMAX-8)+UINTAT((u)+DECPMAX-12)            \
 423            +UINTAT((u)+DECPMAX-16))==0)
 424     #elif DECPMAX==34
 425       #define ISCOEFFZERO(u) (UINTAT((u)+DECPMAX-4)==0              \
 426         && (UINTAT((u)+DECPMAX-8) +UINTAT((u)+DECPMAX-12)           \
 427            +UINTAT((u)+DECPMAX-16)+UINTAT((u)+DECPMAX-20)           \
 428            +UINTAT((u)+DECPMAX-24)+UINTAT((u)+DECPMAX-28)           \
 429            +UINTAT((u)+DECPMAX-32)+USHORTAT((u)+DECPMAX-34))==0)
 430     #endif
 431
 432     /* Macros and masks for the exponent continuation field and MSD   */
 433     /* Get the exponent continuation from a decFloat *df as an Int    */
 434     #define GETECON(df) ((Int)((DFWORD((df), 0)&0x03ffffff)>>(32-6-DECECONL)))
 435     /* Ditto, from the next-wider format                              */
 436     #define GETWECON(df) ((Int)((DFWWORD((df), 0)&0x03ffffff)>>(32-6-DECWECONL)))
 437     /* Get the biased exponent similarly                              */
 438     #define GETEXP(df)  ((Int)(DECCOMBEXP[DFWORD((df), 0)>>26]+GETECON(df)))
 439     /* Get the unbiased exponent similarly                            */
 440     #define GETEXPUN(df) ((Int)GETEXP(df)-DECBIAS)
 441     /* Get the MSD similarly (as uInt)                                */
 442     #define GETMSD(df)   (DECCOMBMSD[DFWORD((df), 0)>>26])
 443
 444     /* Compile-time computes of the exponent continuation field masks */
 445     /* full exponent continuation field:                              */
 446     #define ECONMASK ((0x03ffffff>>(32-6-DECECONL))<<(32-6-DECECONL))
 447     /* same, not including its first digit (the qNaN/sNaN selector):  */
 448     #define ECONNANMASK ((0x01ffffff>>(32-6-DECECONL))<<(32-6-DECECONL))
 449
 450     /* Macros to decode the coefficient in a finite decFloat *df into */
 451     /* a BCD string (uByte *bcdin) of length DECPMAX uBytes           */
 452
 453     /* In-line sequence to convert 10 bits at right end of uInt dpd   */
 454     /* to three BCD8 digits starting at uByte u.  Note that an extra  */
 455     /* byte is written to the right of the three digits because this  */
 456     /* moves four at a time for speed; the alternative macro moves    */
 457     /* exactly three bytes                                            */
 458     #define dpd2bcd8(u, dpd) {                           \
 459       UINTAT(u)=UINTAT(&DPD2BCD8[((dpd)&0x3ff)*4]);}
 460
 461     #define dpd2bcd83(u, dpd) {                          \
 462       *(u)=DPD2BCD8[((dpd)&0x3ff)*4];                    \
 463       *(u+1)=DPD2BCD8[((dpd)&0x3ff)*4+1];                \
 464       *(u+2)=DPD2BCD8[((dpd)&0x3ff)*4+2];}
 465
 466     /* Decode the declets.  After extracting each one, it is decoded  */
 467     /* to BCD8 using a table lookup (also used for variable-length    */
 468     /* decode).  Each DPD decode is 3 bytes BCD8 plus a one-byte      */
 469     /* length which is not used, here).  Fixed-length 4-byte moves    */
 470     /* are fast, however, almost everywhere, and so are used except   */
 471     /* for the final three bytes (to avoid overrun).  The code below  */
 472     /* is 36 instructions for Doubles and about 70 for Quads, even    */
 473     /* on IA32.                                                       */
 474
 475     /* Two macros are defined for each format:                        */
 476     /*   GETCOEFF extracts the coefficient of the current format      */
 477     /*   GETWCOEFF extracts the coefficient of the next-wider format. */
 478     /* The latter is a copy of the next-wider GETCOEFF using DFWWORD. */
 479
 480     #if DECPMAX==7
 481     #define GETCOEFF(df, bcd) {                          \
 482       uInt sourhi=DFWORD(df, 0);                         \
 483       *(bcd)=(uByte)DECCOMBMSD[sourhi>>26];              \
 484       dpd2bcd8(bcd+1, sourhi>>10);                       \
 485       dpd2bcd83(bcd+4, sourhi);}
 486     #define GETWCOEFF(df, bcd) {                         \
 487       uInt sourhi=DFWWORD(df, 0);                        \
 488       uInt sourlo=DFWWORD(df, 1);                        \
 489       *(bcd)=(uByte)DECCOMBMSD[sourhi>>26];              \
 490       dpd2bcd8(bcd+1, sourhi>>8);                        \
 491       dpd2bcd8(bcd+4, (sourhi<<2) | (sourlo>>30));       \
 492       dpd2bcd8(bcd+7, sourlo>>20);                       \
 493       dpd2bcd8(bcd+10, sourlo>>10);                      \
 494       dpd2bcd83(bcd+13, sourlo);}
 495
 496     #elif DECPMAX==16
 497     #define GETCOEFF(df, bcd) {                          \
 498       uInt sourhi=DFWORD(df, 0);                         \
 499       uInt sourlo=DFWORD(df, 1);                         \
 500       *(bcd)=(uByte)DECCOMBMSD[sourhi>>26];              \
 501       dpd2bcd8(bcd+1, sourhi>>8);                        \
 502       dpd2bcd8(bcd+4, (sourhi<<2) | (sourlo>>30));       \
 503       dpd2bcd8(bcd+7, sourlo>>20);                       \
 504       dpd2bcd8(bcd+10, sourlo>>10);                      \
 505       dpd2bcd83(bcd+13, sourlo);}
 506     #define GETWCOEFF(df, bcd) {                         \
 507       uInt sourhi=DFWWORD(df, 0);                        \
 508       uInt sourmh=DFWWORD(df, 1);                        \
 509       uInt sourml=DFWWORD(df, 2);                        \
 510       uInt sourlo=DFWWORD(df, 3);                        \
 511       *(bcd)=(uByte)DECCOMBMSD[sourhi>>26];              \
 512       dpd2bcd8(bcd+1, sourhi>>4);                        \
 513       dpd2bcd8(bcd+4, ((sourhi)<<6) | (sourmh>>26));     \
 514       dpd2bcd8(bcd+7, sourmh>>16);                       \
 515       dpd2bcd8(bcd+10, sourmh>>6);                       \
 516       dpd2bcd8(bcd+13, ((sourmh)<<4) | (sourml>>28));    \
 517       dpd2bcd8(bcd+16, sourml>>18);                      \
 518       dpd2bcd8(bcd+19, sourml>>8);                       \
 519       dpd2bcd8(bcd+22, ((sourml)<<2) | (sourlo>>30));    \
 520       dpd2bcd8(bcd+25, sourlo>>20);                      \
 521       dpd2bcd8(bcd+28, sourlo>>10);                      \
 522       dpd2bcd83(bcd+31, sourlo);}
 523
 524     #elif DECPMAX==34
 525     #define GETCOEFF(df, bcd) {                          \
 526       uInt sourhi=DFWORD(df, 0);                         \
 527       uInt sourmh=DFWORD(df, 1);                         \
 528       uInt sourml=DFWORD(df, 2);                         \
 529       uInt sourlo=DFWORD(df, 3);                         \
 530       *(bcd)=(uByte)DECCOMBMSD[sourhi>>26];              \
 531       dpd2bcd8(bcd+1, sourhi>>4);                        \
 532       dpd2bcd8(bcd+4, ((sourhi)<<6) | (sourmh>>26));     \
 533       dpd2bcd8(bcd+7, sourmh>>16);                       \
 534       dpd2bcd8(bcd+10, sourmh>>6);                       \
 535       dpd2bcd8(bcd+13, ((sourmh)<<4) | (sourml>>28));    \
 536       dpd2bcd8(bcd+16, sourml>>18);                      \
 537       dpd2bcd8(bcd+19, sourml>>8);                       \
 538       dpd2bcd8(bcd+22, ((sourml)<<2) | (sourlo>>30));    \
 539       dpd2bcd8(bcd+25, sourlo>>20);                      \
 540       dpd2bcd8(bcd+28, sourlo>>10);                      \
 541       dpd2bcd83(bcd+31, sourlo);}
 542
 543       #define GETWCOEFF(df, bcd) {??} /* [should never be used]       */
 544     #endif
 545
 546     /* Macros to decode the coefficient in a finite decFloat *df into */
 547     /* a base-billion uInt array, with the least-significant          */
 548     /* 0-999999999 'digit' at offset 0.                               */
 549
 550     /* Decode the declets.  After extracting each one, it is decoded  */
 551     /* to binary using a table lookup.  Three tables are used; one    */
 552     /* the usual DPD to binary, the other two pre-multiplied by 1000  */
 553     /* and 1000000 to avoid multiplication during decode.  These      */
 554     /* tables can also be used for multiplying up the MSD as the DPD  */
 555     /* code for 0 through 9 is the identity.                          */
 556     #define DPD2BIN0 DPD2BIN         /* for prettier code             */
 557
 558     #if DECPMAX==7
 559     #define GETCOEFFBILL(df, buf) {                           \
 560       uInt sourhi=DFWORD(df, 0);                              \
 561       (buf)[0]=DPD2BIN0[sourhi&0x3ff]                         \
 562               +DPD2BINK[(sourhi>>10)&0x3ff]                   \
 563               +DPD2BINM[DECCOMBMSD[sourhi>>26]];}
 564
 565     #elif DECPMAX==16
 566     #define GETCOEFFBILL(df, buf) {                           \
 567       uInt sourhi, sourlo;                                    \
 568       sourlo=DFWORD(df, 1);                                   \
 569       (buf)[0]=DPD2BIN0[sourlo&0x3ff]                         \
 570               +DPD2BINK[(sourlo>>10)&0x3ff]                   \
 571               +DPD2BINM[(sourlo>>20)&0x3ff];                  \
 572       sourhi=DFWORD(df, 0);                                   \
 573       (buf)[1]=DPD2BIN0[((sourhi<<2) | (sourlo>>30))&0x3ff]   \
 574               +DPD2BINK[(sourhi>>8)&0x3ff]                    \
 575               +DPD2BINM[DECCOMBMSD[sourhi>>26]];}
 576
 577     #elif DECPMAX==34
 578     #define GETCOEFFBILL(df, buf) {                           \
 579       uInt sourhi, sourmh, sourml, sourlo;                    \
 580       sourlo=DFWORD(df, 3);                                   \
 581       (buf)[0]=DPD2BIN0[sourlo&0x3ff]                         \
 582               +DPD2BINK[(sourlo>>10)&0x3ff]                   \
 583               +DPD2BINM[(sourlo>>20)&0x3ff];                  \
 584       sourml=DFWORD(df, 2);                                   \
 585       (buf)[1]=DPD2BIN0[((sourml<<2) | (sourlo>>30))&0x3ff]   \
 586               +DPD2BINK[(sourml>>8)&0x3ff]                    \
 587               +DPD2BINM[(sourml>>18)&0x3ff];                  \
 588       sourmh=DFWORD(df, 1);                                   \
 589       (buf)[2]=DPD2BIN0[((sourmh<<4) | (sourml>>28))&0x3ff]   \
 590               +DPD2BINK[(sourmh>>6)&0x3ff]                    \
 591               +DPD2BINM[(sourmh>>16)&0x3ff];                  \
 592       sourhi=DFWORD(df, 0);                                   \
 593       (buf)[3]=DPD2BIN0[((sourhi<<6) | (sourmh>>26))&0x3ff]   \
 594               +DPD2BINK[(sourhi>>4)&0x3ff]                    \
 595               +DPD2BINM[DECCOMBMSD[sourhi>>26]];}
 596
 597     #endif
 598
 599     /* Macros to decode the coefficient in a finite decFloat *df into */
 600     /* a base-thousand uInt array, with the least-significant 0-999   */
 601     /* 'digit' at offset 0.                                           */
 602
 603     /* Decode the declets.  After extracting each one, it is decoded  */
 604     /* to binary using a table lookup.                                */
 605     #if DECPMAX==7
 606     #define GETCOEFFTHOU(df, buf) {                           \
 607       uInt sourhi=DFWORD(df, 0);                              \
 608       (buf)[0]=DPD2BIN[sourhi&0x3ff];                         \
 609       (buf)[1]=DPD2BIN[(sourhi>>10)&0x3ff];                   \
 610       (buf)[2]=DECCOMBMSD[sourhi>>26];}
 611
 612     #elif DECPMAX==16
 613     #define GETCOEFFTHOU(df, buf) {                           \
 614       uInt sourhi, sourlo;                                    \
 615       sourlo=DFWORD(df, 1);                                   \
 616       (buf)[0]=DPD2BIN[sourlo&0x3ff];                         \
 617       (buf)[1]=DPD2BIN[(sourlo>>10)&0x3ff];                   \
 618       (buf)[2]=DPD2BIN[(sourlo>>20)&0x3ff];                   \
 619       sourhi=DFWORD(df, 0);                                   \
 620       (buf)[3]=DPD2BIN[((sourhi<<2) | (sourlo>>30))&0x3ff];   \
 621       (buf)[4]=DPD2BIN[(sourhi>>8)&0x3ff];                    \
 622       (buf)[5]=DECCOMBMSD[sourhi>>26];}
 623
 624     #elif DECPMAX==34
 625     #define GETCOEFFTHOU(df, buf) {                           \
 626       uInt sourhi, sourmh, sourml, sourlo;                    \
 627       sourlo=DFWORD(df, 3);                                   \
 628       (buf)[0]=DPD2BIN[sourlo&0x3ff];                         \
 629       (buf)[1]=DPD2BIN[(sourlo>>10)&0x3ff];                   \
 630       (buf)[2]=DPD2BIN[(sourlo>>20)&0x3ff];                   \
 631       sourml=DFWORD(df, 2);                                   \
 632       (buf)[3]=DPD2BIN[((sourml<<2) | (sourlo>>30))&0x3ff];   \
 633       (buf)[4]=DPD2BIN[(sourml>>8)&0x3ff];                    \
 634       (buf)[5]=DPD2BIN[(sourml>>18)&0x3ff];                   \
 635       sourmh=DFWORD(df, 1);                                   \
 636       (buf)[6]=DPD2BIN[((sourmh<<4) | (sourml>>28))&0x3ff];   \
 637       (buf)[7]=DPD2BIN[(sourmh>>6)&0x3ff];                    \
 638       (buf)[8]=DPD2BIN[(sourmh>>16)&0x3ff];                   \
 639       sourhi=DFWORD(df, 0);                                   \
 640       (buf)[9]=DPD2BIN[((sourhi<<6) | (sourmh>>26))&0x3ff];   \
 641       (buf)[10]=DPD2BIN[(sourhi>>4)&0x3ff];                   \
 642       (buf)[11]=DECCOMBMSD[sourhi>>26];}
 643
 644     #endif
 645
 646     /* Set a decFloat to the maximum positive finite number (Nmax)    */
 647     #if DECPMAX==7
 648     #define DFSETNMAX(df)            \
 649       {DFWORD(df, 0)=0x77f3fcff;}
 650     #elif DECPMAX==16
 651     #define DFSETNMAX(df)            \
 652       {DFWORD(df, 0)=0x77fcff3f;     \
 653        DFWORD(df, 1)=0xcff3fcff;}
 654     #elif DECPMAX==34
 655     #define DFSETNMAX(df)            \
 656       {DFWORD(df, 0)=0x77ffcff3;     \
 657        DFWORD(df, 1)=0xfcff3fcf;     \
 658        DFWORD(df, 2)=0xf3fcff3f;     \
 659        DFWORD(df, 3)=0xcff3fcff;}
 660     #endif
 661
 662   /* [end of format-dependent macros and constants]                   */
 663   #endif
 664
 665 #else
 666   #error decNumberLocal included more than once
 667 #endif