sysdeps/generic/math-type-macros.h

   1 /* Helper macros for type generic function implementations within libm.
   2    Copyright (C) 2016 Free Software Foundation, Inc.
   3    This file is part of the GNU C Library.
   4
   5    The GNU C Library is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU Lesser General Public
   7    License as published by the Free Software Foundation; either
   8    version 2.1 of the License, or (at your option) any later version.
   9
  10    The GNU C Library is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    Lesser General Public License for more details.
  14
  15    You should have received a copy of the GNU Lesser General Public
  16    License along with the GNU C Library; if not, see
  17    <http://www.gnu.org/licenses/>.  */
  18
  19 #ifndef _MATH_TYPE_MACROS
  20 #define _MATH_TYPE_MACROS
  21
  22 /* Each type imports a header which is expected to
  23    define:
  24
  25    M_LIT(x)   - Paste the type specific suffix onto the constant x.
  26    M_MLIT(x)  - Paste the type specific suffix used by the macro
  27                 constants in math.h, i.e M_PI or M_PIl.
  28    M_PFX      - The prefixed used by float.h macros like FLT_MANT_DIG.
  29    M_SUF(x)   - Paste the the type specific suffix used by functions
  30                 i.e expf expl exp.
  31    FLOAT      - Resolves to the C typename of M_TYPE.
  32    CFLOAT     - Resolves to the complex typename of M_TYPE.
  33
  34   Optionally, these headers may inject a non-standard
  35   definition for the following:
  36
  37   declare_mgen_alias(from,to)
  38       This exposes the appropriate symbol(s) for a
  39       function f of type FLOAT.
  40
  41   declare_mgen_alias_2(from,to,to2)
  42       This exposes the appropriate symbol(s) for a
  43       function f of type FLOAT when it is aliased
  44       to two symbols.
  45
  46   M_LIBM_NEED_COMPAT(func)
  47       This is utilized in macro context to indicate
  48       whether func should declare compat symbols.
  49
  50   declare_mgen_libm_compat(from,to)
  51       This is used in conjunction with the above macro
  52       outside of macro context to paste whatever is
  53       required to generate a compat symbol. */
  54
  55 #ifndef M_PFX
  56 # error "M_PFX must be defined."
  57 #endif
  58 #ifndef M_LIT
  59 # error "M_LIT must be defined."
  60 #endif
  61 #ifndef M_MLIT
  62 # error "M_MLIT must be defined."
  63 #endif
  64 #ifndef M_SUF
  65 # error "M_SUF must be defined."
  66 #endif
  67 #ifndef FLOAT
  68 # error "FLOAT must be defined."
  69 #endif
  70 #ifndef CFLOAT
  71 # error "CFLOAT must be defined."
  72 #endif
  73
  74 #define __M_CONCAT(a,b) a ## b
  75 #define __M_CONCATX(a,b) __M_CONCAT(a,b)
  76
  77 #define M_NAN M_SUF (__builtin_nan) ("")
  78 #define M_MAX_EXP __M_CONCATX (M_PFX, _MAX_EXP)
  79 #define M_MIN __M_CONCATX (M_PFX, _MIN)
  80 #define M_MAX __M_CONCATX (M_PFX, _MAX)
  81 #define M_MANT_DIG __M_CONCATX (M_PFX, _MANT_DIG)
  82 #define M_HUGE_VAL (M_SUF (__builtin_huge_val) ())
  83
  84 /* Helper macros for commonly used functions.  */
  85 #define M_COPYSIGN M_SUF (__copysign)
  86 #define M_FABS M_SUF (fabs)
  87 #define M_SINCOS M_SUF (__sincos)
  88 #define M_SCALBN M_SUF (__scalbn)
  89 #define M_LOG1P M_SUF (__log1p)
  90
  91 #define M_ATAN2 M_SUF (__ieee754_atan2)
  92 #define M_COSH M_SUF (__ieee754_cosh)
  93 #define M_EXP M_SUF (__ieee754_exp)
  94 #define M_HYPOT M_SUF (__ieee754_hypot)
  95 #define M_LOG M_SUF (__ieee754_log)
  96 #define M_SINH M_SUF (__ieee754_sinh)
  97 #define M_SQRT M_SUF (__ieee754_sqrt)
  98
  99 /* Needed to evaluate M_MANT_DIG below.  */
 100 #include <float.h>
 101
 102 /* Use a special epsilon value for IBM long double
 103    to avoid spurious overflows/underflows.  */
 104 #if M_MANT_DIG != 106
 105 # define M_EPSILON __M_CONCATX (M_PFX, _EPSILON)
 106 #else
 107 # define M_EPSILON M_LIT (0x1p-106)
 108 #endif
 109
 110 /* Enable overloading of function name to assist reuse.  */
 111 #ifndef M_DECL_FUNC
 112 # define M_DECL_FUNC(f) M_SUF (f)
 113 #endif
 114
 115 /* If the type does not declare special aliasing, use the default.  */
 116 #ifndef declare_mgen_alias
 117 # define declare_mgen_alias(from, to) weak_alias (M_SUF (from), M_SUF (to))
 118 #endif
 119
 120 /* Likewise, if two aliases are derived from the same symbol.  */
 121 #ifndef declare_mgen_alias_2
 122 # define declare_mgen_alias_2(from, to, to2)  \
 123  declare_mgen_alias (from, to)                \
 124  declare_mgen_alias (from, to2)
 125 #endif
 126
 127 /* Do not generate anything for compat symbols by default.  */
 128 #ifndef M_LIBM_NEED_COMPAT
 129 # define M_LIBM_NEED_COMPAT(func) 0
 130 # define declare_mgen_libm_compat(from, to)
 131 #endif
 132
 133 #endif /* _MATH_TYPE_MACROS */