path: root/tests/tversion.c

/* Test file for mpfr_version.

Copyright 2004-2021 Free Software Foundation, Inc.
Contributed by the AriC and Caramba projects, INRIA.

This file is part of the GNU MPFR Library.

The GNU MPFR Library is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 3 of the License, or (at your
option) any later version.

The GNU MPFR Library is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
License for more details.

You should have received a copy of the GNU Lesser General Public License
along with the GNU MPFR Library; see the file COPYING.LESSER.  If not, see
https://www.gnu.org/licenses/ or write to the Free Software Foundation, Inc.,
51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. */

#include <errno.h>

#define MPFR_NEED_INTMAX_H
#include "mpfr-test.h"

/* Warning about the usage of printf/puts below:
 *
 *   - If a macro expansion is used, it must not appear in the first
 *     argument of printf (format string), as we do not know whether
 *     the expanded string contains a '%' character.
 *
 *   - If a #if preprocessor directive is used in an argument, parentheses
 *     must be put around the function name, in case this function is also
 *     implemented as a macro (#if does not work in macro arguments).
 */

int
main (void)
{
  mpfr_exp_t e;
  int err = 0;

  /* Test the GMP and MPFR versions. */
  if (test_version ())
    exit (1);

  tests_start_mpfr ();

  errno = 0;

  /*********************** MPFR version and patches ************************/

  /* The printf failure test was added because of an output issue under Wine,
   * eventually not related to this output; this test is kept just in case...
   * Details:
   *   https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=914822
   *   https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=914949
   */
  if (printf ("[tversion] MPFR %s\n", MPFR_VERSION_STRING) < 0)
    {
      perror ("tversion (first printf)");
      err = 1;
    }

  if (strcmp (mpfr_get_patches (), "") != 0)
    printf ("[tversion] MPFR patches: %s\n", mpfr_get_patches ());

  /************************* Compiler information **************************/

  /* TODO: We may want to output info for non-GNUC-compat compilers too. See:
   * http://sourceforge.net/p/predef/wiki/Compilers/
   * http://nadeausoftware.com/articles/2012/10/c_c_tip_how_detect_compiler_name_and_version_using_compiler_predefined_macros
   *
   * For ICC, do not check the __ICC macro as it is obsolete and not always
   * defined (in particular, on MS Windows).
   */
#define COMP "[tversion] Compiler: "
#ifdef __INTEL_COMPILER
# ifdef __VERSION__
#  define ICCV " [" __VERSION__ "]"
# else
#  define ICCV ""
# endif
  printf (COMP "ICC %d.%d.%d" ICCV "\n", __INTEL_COMPILER / 100,
          __INTEL_COMPILER % 100, __INTEL_COMPILER_UPDATE);
#elif defined(__TINYC__)
  /* The format of __TINYC__ is not described, but libtcc.c defines it with
   *   sprintf(buffer, "%d", a*10000 + b*100 + c);
   *   tcc_define_symbol(s, "__TINYC__", buffer);
   */
  printf (COMP "TCC %d.%d.%d\n", (int) (__TINYC__ / 10000),
          (int) ((__TINYC__ / 100) % 100), (int) (__TINYC__ % 100));
#elif (defined(__GNUC__) || defined(__clang__)) && defined(__VERSION__)
# ifdef __clang__
#  define COMP2 COMP
# else
#  define COMP2 COMP "GCC "
# endif
  printf (COMP2 "%s\n", __VERSION__);
#endif

  /************** More information about the C implementation **************/

  /* The following macros are currently used by src/mpfr-cvers.h and/or
     src/mpfr-impl.h; they may have an influcence on how MPFR is compiled. */

#if defined(__STDC__) || defined(__STDC_VERSION__)
  (puts) ("[tversion] C standard: __STDC__ = "
#if defined(__STDC__)
          MAKE_STR(__STDC__)
#else
          "undef"
#endif
          ", __STDC_VERSION__ = "
#if defined(__STDC_VERSION__)
          MAKE_STR(__STDC_VERSION__)
#else
          "undef"
#endif
          );
#endif

#if defined(__GNUC__)
  (puts) ("[tversion] __GNUC__ = " MAKE_STR(__GNUC__) ", __GNUC_MINOR__ = "
#if defined(__GNUC_MINOR__)
          MAKE_STR(__GNUC_MINOR__)
#else
          "undef"
#endif
#if defined(__STRICT_ANSI__)
          ", __STRICT_ANSI__"
#endif
          );
#endif

#if defined(__ICC) || defined(__INTEL_COMPILER)
  (puts) ("[tversion] Intel compiler: __ICC = "
#if defined(__ICC)
          MAKE_STR(__ICC)
#else
          "undef"
#endif
          ", __INTEL_COMPILER = "
#if defined(__INTEL_COMPILER)
          MAKE_STR(__INTEL_COMPILER)
#else
          "undef"
#endif
          );
#endif

#if defined(_WIN32) || defined(_MSC_VER)
  (puts) ("[tversion] MS Windows: _WIN32 = "
#if defined(_WIN32)
          MAKE_STR(_WIN32)
#else
          "undef"
#endif
          ", _MSC_VER = "
#if defined(_MSC_VER)
          MAKE_STR(_MSC_VER)
#else
          "undef"
#endif
          );
#endif

  /* With MinGW64, both __MINGW32__ and __MINGW64__ seem to be defined,
     but test both, just in case this will change in the future. Tested
     with "x86_64-w64-mingw32-gcc -dM -E -xc /dev/null" under Debian. */
#if defined(__MINGW32__) || defined(__MINGW64__)
  (puts) ("[tversion] MinGW"
#if defined(__MINGW64__)
          "64"
#else
          "32"
#endif
          ": __USE_MINGW_ANSI_STDIO = "
#if defined(__USE_MINGW_ANSI_STDIO)
          MAKE_STR(__USE_MINGW_ANSI_STDIO)
#else
          "undef"
#endif
          );
#endif

#if defined(__GLIBC__)
  (puts) ("[tversion] __GLIBC__ = " MAKE_STR(__GLIBC__) ", __GLIBC_MINOR__ = "
#if defined(__GLIBC_MINOR__)
          MAKE_STR(__GLIBC_MINOR__)
#else
          "undef"
#endif
          );
#endif

  /******************* GMP version and build information *******************/

#ifdef __MPIR_VERSION
  printf ("[tversion] MPIR: header %d.%d.%d, library %s\n",
          __MPIR_VERSION, __MPIR_VERSION_MINOR, __MPIR_VERSION_PATCHLEVEL,
          mpir_version);
#else
#ifdef MPFR_USE_MINI_GMP
  printf ("[tversion] mini-gmp\n");
#else
  printf ("[tversion] GMP: header %d.%d.%d, library %s\n",
          __GNU_MP_VERSION, __GNU_MP_VERSION_MINOR, __GNU_MP_VERSION_PATCHLEVEL,
          gmp_version);
#endif
#endif

#ifdef __GMP_CC
  printf ("[tversion] __GMP_CC = \"%s\"\n", __GMP_CC);
#endif
#ifdef __GMP_CFLAGS
  printf ("[tversion] __GMP_CFLAGS = \"%s\"\n", __GMP_CFLAGS);
#endif

  /* The following output is also useful under Unix, where one should get:
     WinDLL: __GMP_LIBGMP_DLL = 0, MPFR_WIN_THREAD_SAFE_DLL = undef
     If this is not the case, something is probably broken. We cannot test
     automatically as some MS Windows implementations may declare some Unix
     (POSIX) compatibility; for instance, Cygwin32 defines __unix__ (but
     Cygwin64 does not, probably because providing both MS Windows API and
     POSIX API is not possible with a 64-bit ABI, since MS Windows is LLP64
     and Unix is LP64).
     MPFR_WIN_THREAD_SAFE_DLL is directly set up from __GMP_LIBGMP_DLL;
     that is why it is output here. */
  (puts) ("[tversion] WinDLL: __GMP_LIBGMP_DLL = "
#if defined(__GMP_LIBGMP_DLL)
          MAKE_STR(__GMP_LIBGMP_DLL)
#else
          "undef"
#endif
          ", MPFR_WIN_THREAD_SAFE_DLL = "
#if defined(MPFR_WIN_THREAD_SAFE_DLL)
          MAKE_STR(MPFR_WIN_THREAD_SAFE_DLL)
#else
          "undef"
#endif
          );

  /********************* MPFR configuration parameters *********************/

  /* The following code outputs configuration parameters, either set up
     by the user or determined automatically (default values). */

  if (
#ifdef MPFR_USE_THREAD_SAFE
      !
#endif
      mpfr_buildopt_tls_p ())
    {
      printf ("ERROR! mpfr_buildopt_tls_p() and macros"
              " do not match!\n");
      err = 1;
    }

  if (
#ifdef MPFR_WANT_FLOAT128
      !
#endif
      mpfr_buildopt_float128_p ())
    {
      printf ("ERROR! mpfr_buildopt_float128_p() and macros"
              " do not match!\n");
      err = 1;
    }

  if (
#ifdef MPFR_WANT_DECIMAL_FLOATS
      !
#endif
      mpfr_buildopt_decimal_p ())
    {
      printf ("ERROR! mpfr_buildopt_decimal_p() and macros"
              " do not match!\n");
      err = 1;
    }

  if (
#if defined(MPFR_HAVE_GMP_IMPL) || defined(WANT_GMP_INTERNALS)
      !
#endif
      mpfr_buildopt_gmpinternals_p ())
    {
      printf ("ERROR! mpfr_buildopt_gmpinternals_p() and macros"
              " do not match!\n");
      err = 1;
    }

#if defined(MPFR_HAVE_GMP_IMPL)
  (puts) ("[tversion] MPFR built with the GMP build (--with-gmp-build)");
#else
  (printf) ("[tversion] MPFR_ALLOCA_MAX = %ld\n", (long) MPFR_ALLOCA_MAX);
#endif

  if (
#ifdef MPFR_WANT_SHARED_CACHE
      !
#endif
      mpfr_buildopt_sharedcache_p ())
    {
      printf ("ERROR! mpfr_buildopt_sharedcache_p() and macros"
              " do not match!\n");
      err = 1;
    }

  (printf) ("[tversion] TLS = %s, float128 = %s, decimal = %s,"
            " GMP internals = %s\n",
            mpfr_buildopt_tls_p () ? "yes" : "no",
            mpfr_buildopt_float128_p () ? "yes" : "no",
            mpfr_buildopt_decimal_p () ? "yes"
#if defined(DECIMAL_BID_FORMAT)
            " (BID)"
#elif defined(DECIMAL_DPD_FORMAT)
            " (DPD)"
#endif
            : "no",
            mpfr_buildopt_gmpinternals_p () ? "yes" : "no");

#ifdef MPFR_THREAD_LOCK_METHOD
# define LOCK_METHOD " (lock method: " MPFR_THREAD_LOCK_METHOD ")"
#else
# define LOCK_METHOD ""
#endif

  (printf) ("[tversion] Shared cache = %s\n",
            mpfr_buildopt_sharedcache_p () ? "yes" LOCK_METHOD : "no");

  (puts) ("[tversion] intmax_t = "
#if defined(_MPFR_H_HAVE_INTMAX_T)
          "yes"
#else
          "no"
#endif
          ", printf = "
#if defined(HAVE_STDARG) && !defined(MPFR_USE_MINI_GMP)
          "yes"
#else
          "no"
#endif
          ", IEEE floats = "
#if _MPFR_IEEE_FLOATS
          "yes"
#else
          "no"
#endif
          );

  (puts) ("[tversion] gmp_printf: hhd = "
#if defined(NPRINTF_HH)
          "no"
#else
          "yes"
#endif
          ", lld = "
#if defined(NPRINTF_LL)
          "no"
#else
          "yes"
#endif
          ", jd = "
#if defined(NPRINTF_J)
          "no"
#else
          "yes"
#endif
          ", td = "
#if defined(NPRINTF_T)
          "no"
#elif defined(PRINTF_T)
          "yes"
#else
          "?"
#endif
          ", Ld = "
#if defined(NPRINTF_L)
          "no"
#elif defined(PRINTF_L)
          "yes"
#else
          "?"
#endif
          );

  (puts) ("[tversion] _mulx_u64 = "
#if defined(HAVE_MULX_U64)
          "yes"
#else
          "no"
#endif
          );

  if (strcmp (mpfr_buildopt_tune_case (), MPFR_TUNE_CASE) != 0)
    {
      printf ("ERROR! mpfr_buildopt_tune_case() and MPFR_TUNE_CASE"
              " do not match!\n  %s\n  %s\n",
              mpfr_buildopt_tune_case (), MPFR_TUNE_CASE);
      err = 1;
    }
  else
    printf ("[tversion] MPFR tuning parameters from %s\n", MPFR_TUNE_CASE);

  /**************************** ABI information ****************************/

  (printf) ("[tversion] sizeof(long) = %ld, sizeof(mpfr_intmax_t) = %ld"
#if defined(_MPFR_H_HAVE_INTMAX_T)
            ", sizeof(intmax_t) = %ld"
#endif
            "\n", (long) sizeof(long), (long) sizeof(mpfr_intmax_t)
#if defined(_MPFR_H_HAVE_INTMAX_T)
            , (long) sizeof(intmax_t)
#endif
            );

  if (mp_bits_per_limb != GMP_NUMB_BITS)
    {
      printf ("ERROR! mp_bits_per_limb != GMP_NUMB_BITS (%ld vs %ld)\n",
              (long) mp_bits_per_limb, (long) GMP_NUMB_BITS);
      err = 1;
    }

  printf ("[tversion] GMP_NUMB_BITS = %ld, sizeof(mp_limb_t) = %ld\n",
          (long) GMP_NUMB_BITS, (long) sizeof(mp_limb_t));

  /* Concerning the MPFR_LONG_WITHIN_LIMB and MPFR_INTMAX_WITHIN_LIMB macros,
     if defined, code may be optimized to take these properties into account.
     If not defined, MPFR should select portable code. So one should ideally
     get either "y/y" or "n/n"; "n/y" is allowed, but "y/n" is forbidden.
     Note: MPFR_LONG_WITHIN_LIMB should be defined by the configure script,
     but may also be defined by the src/mpfr-impl.h header file. */
#define WITHIN_LIMB(T)                         \
  (MPFR_LIMB_MAX >= (T) -1 ?                   \
   ((WM) ? "y/y" : "n/y") :                    \
   ((WM) ? (err = 1, "y/n (WRONG!)") : "n/n"))

  (printf) ("[tversion] Within limb: long = %s"
#if defined(_MPFR_H_HAVE_INTMAX_T)
            ", intmax_t = %s"
#endif
            "\n"
#undef WM
#if defined(MPFR_LONG_WITHIN_LIMB)
# define WM 1
#else
# define WM 0
#endif
            , WITHIN_LIMB (unsigned long)
#if defined(_MPFR_H_HAVE_INTMAX_T)
#undef WM
#if defined(MPFR_INTMAX_WITHIN_LIMB)
# define WM 1
#else
# define WM 0
#endif
            , WITHIN_LIMB (uintmax_t)
#endif
            );

  printf ("[tversion] _MPFR_PREC_FORMAT = %ld, sizeof(mpfr_prec_t) = %ld\n",
          (long) _MPFR_PREC_FORMAT, (long) sizeof(mpfr_prec_t));

  printf ("[tversion] _MPFR_EXP_FORMAT = %ld, sizeof(mpfr_exp_t) = %ld\n",
          (long) _MPFR_EXP_FORMAT, (long) sizeof(mpfr_exp_t));

  printf ("[tversion] sizeof(mpfr_t) = %ld, sizeof(mpfr_ptr) = %ld\n",
          (long) sizeof(mpfr_t), (long) sizeof(mpfr_ptr));

#define RANGE " range: [%" MPFR_EXP_FSPEC "d,%" MPFR_EXP_FSPEC "d]\n"

  printf ("[tversion] Precision" RANGE,
          (mpfr_eexp_t) MPFR_PREC_MIN, (mpfr_eexp_t) MPFR_PREC_MAX);

  e = mpfr_get_emin_min ();
  if (e != MPFR_EMIN_MIN)
    {
      printf ("ERROR! mpfr_get_emin_min != MPFR_EMIN_MIN (%"
              MPFR_EXP_FSPEC "d vs %" MPFR_EXP_FSPEC "d)\n",
              (mpfr_eexp_t) e, (mpfr_eexp_t) MPFR_EMIN_MIN);
      err = 1;
    }

  e = mpfr_get_emax_max ();
  if (e != MPFR_EMAX_MAX)
    {
      printf ("ERROR! mpfr_get_emax_max != MPFR_EMAX_MAX (%"
              MPFR_EXP_FSPEC "d vs %" MPFR_EXP_FSPEC "d)\n",
              (mpfr_eexp_t) e, (mpfr_eexp_t) MPFR_EMAX_MAX);
      err = 1;
    }

  printf ("[tversion] Max exponent" RANGE,
          (mpfr_eexp_t) MPFR_EMIN_MIN, (mpfr_eexp_t) MPFR_EMAX_MAX);

  (puts) ("[tversion] Generic ABI code: "
#if defined(MPFR_GENERIC_ABI)
          "yes"
#else
          "no"
#endif
          );

  (puts) ("[tversion] Enable formally proven code: "
#if defined(MPFR_WANT_PROVEN_CODE)
          "yes"
#else
          "no"
#endif
          );

  /************************* Run-time information **************************/

  if (locale != NULL)
    printf ("[tversion] Locale: %s\n", locale);
  /* The memory limit should not be changed for "make check".
     The warning below signals a possible user mistake.
     Do not use "%zu" because it is not available in C90;
     the type mpfr_ueexp_t should be sufficiently large. */
  if (tests_memory_limit != DEFAULT_MEMORY_LIMIT)
    printf ("[tversion] Warning! Memory limit changed to %" MPFR_EXP_FSPEC
            "u\n", (mpfr_ueexp_t) tests_memory_limit);

  /*************************************************************************/

  if (errno != 0)
    {
      perror ("tversion");
      err = 1;
    }

  tests_end_mpfr ();

  return err;
}