cannam@127: /* See bench.c.  We keep a few common subroutines in this file so
cannam@127:    that they can be re-used in the MPI test program. */
cannam@127: 
cannam@127: #include <math.h>
cannam@127: #include <stdio.h>
cannam@127: #include <string.h>
cannam@127: #include "fftw-bench.h"
cannam@127: 
cannam@127: /* define to enable code that traps floating-point exceptions.
cannam@127:    Disabled by default because I don't want to worry about the
cannam@127:    portability of such code.  feenableexcept() seems to be a GNU
cannam@127:    thing */
cannam@127: #undef TRAP_FP_EXCEPTIONS
cannam@127: 
cannam@127: #ifdef TRAP_FP_EXCEPTIONS
cannam@127: #  include <signal.h>
cannam@127: #  include <fenv.h>
cannam@127: #endif
cannam@127: 
cannam@127: #ifdef _OPENMP
cannam@127: #  include <omp.h>
cannam@127: #endif
cannam@127: 
cannam@127: #ifdef HAVE_SMP
cannam@127: int threads_ok = 1;
cannam@127: #endif
cannam@127: 
cannam@127: FFTW(plan) the_plan = 0;
cannam@127: 
cannam@127: static const char *wisdat = "wis.dat";
cannam@127: unsigned the_flags = 0;
cannam@127: int paranoid = 0;
cannam@127: int usewisdom = 0;
cannam@127: int havewisdom = 0;
cannam@127: int nthreads = 1;
cannam@127: int amnesia = 0;
cannam@127: 
cannam@127: extern void install_hook(void);  /* in hook.c */
cannam@127: extern void uninstall_hook(void);  /* in hook.c */
cannam@127: 
cannam@127: #ifdef FFTW_RANDOM_ESTIMATOR
cannam@127: extern unsigned FFTW(random_estimate_seed);
cannam@127: #endif
cannam@127: 
cannam@127: #ifdef TRAP_FP_EXCEPTIONS
cannam@127: static void sigfpe_handler(int sig, siginfo_t *info, void *context)
cannam@127: {
cannam@127:      /* fftw code is not supposed to generate FP exceptions */
cannam@127:      UNUSED(sig); UNUSED(info); UNUSED(context);
cannam@127:      fprintf(stderr, "caught FPE, aborting\n");
cannam@127:      abort();
cannam@127: }
cannam@127: 
cannam@127: static void setup_sigfpe_handler(void)
cannam@127: {
cannam@127:   struct sigaction a;
cannam@127:   feenableexcept(FE_DIVBYZERO | FE_INVALID | FE_OVERFLOW | FE_UNDERFLOW);
cannam@127:   memset(&a, 0, sizeof(a));
cannam@127:   a.sa_sigaction = sigfpe_handler;
cannam@127:   a.sa_flags = SA_SIGINFO;
cannam@127:   if (sigaction(SIGFPE, &a, NULL) == -1) {
cannam@127:        fprintf(stderr, "cannot install sigfpe handler\n");
cannam@127:        exit(1);
cannam@127:   }
cannam@127: }
cannam@127: #else
cannam@127: static void setup_sigfpe_handler(void)
cannam@127: {
cannam@127: }
cannam@127: #endif
cannam@127: 
cannam@127: void useropt(const char *arg)
cannam@127: {
cannam@127:      int x;
cannam@127:      double y;
cannam@127: 
cannam@127:      if (!strcmp(arg, "patient")) the_flags |= FFTW_PATIENT;
cannam@127:      else if (!strcmp(arg, "estimate")) the_flags |= FFTW_ESTIMATE;
cannam@127:      else if (!strcmp(arg, "estimatepat")) the_flags |= FFTW_ESTIMATE_PATIENT;
cannam@127:      else if (!strcmp(arg, "exhaustive")) the_flags |= FFTW_EXHAUSTIVE;
cannam@127:      else if (!strcmp(arg, "unaligned")) the_flags |= FFTW_UNALIGNED;
cannam@127:      else if (!strcmp(arg, "nosimd")) the_flags |= FFTW_NO_SIMD;
cannam@127:      else if (!strcmp(arg, "noindirectop")) the_flags |= FFTW_NO_INDIRECT_OP;
cannam@127:      else if (!strcmp(arg, "wisdom-only")) the_flags |= FFTW_WISDOM_ONLY;
cannam@127:      else if (sscanf(arg, "flag=%d", &x) == 1) the_flags |= x;
cannam@127:      else if (sscanf(arg, "bflag=%d", &x) == 1) the_flags |= 1U << x;
cannam@127:      else if (!strcmp(arg, "paranoid")) paranoid = 1;
cannam@127:      else if (!strcmp(arg, "wisdom")) usewisdom = 1;
cannam@127:      else if (!strcmp(arg, "amnesia")) amnesia = 1;
cannam@127:      else if (sscanf(arg, "nthreads=%d", &x) == 1) nthreads = x;
cannam@127: #ifdef FFTW_RANDOM_ESTIMATOR
cannam@127:      else if (sscanf(arg, "eseed=%d", &x) == 1) FFTW(random_estimate_seed) = x;
cannam@127: #endif
cannam@127:      else if (sscanf(arg, "timelimit=%lg", &y) == 1) {
cannam@127: 	  FFTW(set_timelimit)(y);
cannam@127:      }
cannam@127: 
cannam@127:      else fprintf(stderr, "unknown user option: %s.  Ignoring.\n", arg);
cannam@127: }
cannam@127: 
cannam@127: void rdwisdom(void)
cannam@127: {
cannam@127:      FILE *f;
cannam@127:      double tim;
cannam@127:      int success = 0;
cannam@127: 
cannam@127:      if (havewisdom) return;
cannam@127: 
cannam@127: #ifdef HAVE_SMP
cannam@127:      if (threads_ok) {
cannam@127: 	  BENCH_ASSERT(FFTW(init_threads)());
cannam@127: 	  FFTW(plan_with_nthreads)(nthreads);
cannam@127:           FFTW(make_planner_thread_safe)();
cannam@127: #ifdef _OPENMP
cannam@127: 	  omp_set_num_threads(nthreads);
cannam@127: #endif
cannam@127:      }
cannam@127:      else if (nthreads > 1 && verbose > 1) {
cannam@127: 	  fprintf(stderr, "bench: WARNING - nthreads = %d, but threads not supported\n", nthreads);
cannam@127: 	  nthreads = 1;
cannam@127:      }
cannam@127: #endif
cannam@127: 
cannam@127:      if (!usewisdom) return;
cannam@127: 
cannam@127:      timer_start(USER_TIMER);
cannam@127:      if ((f = fopen(wisdat, "r"))) {
cannam@127: 	  if (!import_wisdom(f))
cannam@127: 	       fprintf(stderr, "bench: ERROR reading wisdom\n");
cannam@127: 	  else
cannam@127: 	       success = 1;
cannam@127: 	  fclose(f);
cannam@127:      }
cannam@127:      tim = timer_stop(USER_TIMER);
cannam@127: 
cannam@127:      if (success) {
cannam@127: 	  if (verbose > 1) printf("READ WISDOM (%g seconds): ", tim);
cannam@127: 	  
cannam@127: 	  if (verbose > 3)
cannam@127: 	       export_wisdom(stdout);
cannam@127: 	  if (verbose > 1)
cannam@127: 	       printf("\n");
cannam@127:      }
cannam@127:      havewisdom = 1;
cannam@127: }
cannam@127: 
cannam@127: void wrwisdom(void)
cannam@127: {
cannam@127:      FILE *f;
cannam@127:      double tim;
cannam@127:      if (!havewisdom) return;
cannam@127: 
cannam@127:      timer_start(USER_TIMER);
cannam@127:      if ((f = fopen(wisdat, "w"))) {
cannam@127: 	  export_wisdom(f);
cannam@127: 	  fclose(f);
cannam@127:      }
cannam@127:      tim = timer_stop(USER_TIMER);
cannam@127:      if (verbose > 1) printf("write wisdom took %g seconds\n", tim);
cannam@127: }
cannam@127: 
cannam@127: static unsigned preserve_input_flags(bench_problem *p)
cannam@127: {
cannam@127:      /*
cannam@127:       * fftw3 cannot preserve input for multidimensional c2r transforms.
cannam@127:       * Enforce FFTW_DESTROY_INPUT
cannam@127:       */
cannam@127:      if (p->kind == PROBLEM_REAL && 
cannam@127: 	 p->sign > 0 && 
cannam@127: 	 !p->in_place && 
cannam@127: 	 p->sz->rnk > 1)
cannam@127: 	  p->destroy_input = 1;
cannam@127: 
cannam@127:      if (p->destroy_input)
cannam@127: 	  return FFTW_DESTROY_INPUT;
cannam@127:      else
cannam@127: 	  return FFTW_PRESERVE_INPUT;
cannam@127: }
cannam@127: 
cannam@127: int can_do(bench_problem *p)
cannam@127: {
cannam@127:      double tim;
cannam@127: 
cannam@127:      if (verbose > 2 && p->pstring)
cannam@127: 	  printf("Planning %s...\n", p->pstring);
cannam@127:      rdwisdom();
cannam@127: 
cannam@127:      timer_start(USER_TIMER);
cannam@127:      the_plan = mkplan(p, preserve_input_flags(p) | the_flags | FFTW_ESTIMATE);
cannam@127:      tim = timer_stop(USER_TIMER);
cannam@127:      if (verbose > 2) printf("estimate-planner time: %g s\n", tim);
cannam@127: 
cannam@127:      if (the_plan) {
cannam@127: 	  FFTW(destroy_plan)(the_plan);
cannam@127: 	  return 1;
cannam@127:      }
cannam@127:      return 0;
cannam@127: }
cannam@127: 
cannam@127: void setup(bench_problem *p)
cannam@127: {
cannam@127:      double tim;
cannam@127: 
cannam@127:      setup_sigfpe_handler();
cannam@127:      
cannam@127:      if (amnesia) {
cannam@127: 	  FFTW(forget_wisdom)();
cannam@127: 	  havewisdom = 0;
cannam@127:      }
cannam@127: 
cannam@127:      /* Regression test: check that fftw_malloc exists and links
cannam@127:       * properly */
cannam@127:      {
cannam@127:           void *ptr = FFTW(malloc(42));
cannam@127:           BENCH_ASSERT(FFTW(alignment_of)(ptr) == 0);
cannam@127:           FFTW(free(ptr));
cannam@127:      }
cannam@127: 
cannam@127:      rdwisdom();
cannam@127:      install_hook();
cannam@127: 
cannam@127: #ifdef HAVE_SMP
cannam@127:      if (verbose > 1 && nthreads > 1) printf("NTHREADS = %d\n", nthreads);
cannam@127: #endif
cannam@127: 
cannam@127:      timer_start(USER_TIMER);
cannam@127:      the_plan = mkplan(p, preserve_input_flags(p) | the_flags);
cannam@127:      tim = timer_stop(USER_TIMER);
cannam@127:      if (verbose > 1) printf("planner time: %g s\n", tim);
cannam@127: 
cannam@127:      BENCH_ASSERT(the_plan);
cannam@127: 
cannam@127:      {
cannam@127: 	  double add, mul, nfma, cost, pcost;
cannam@127: 	  FFTW(flops)(the_plan, &add, &mul, &nfma);
cannam@127: 	  cost = FFTW(estimate_cost)(the_plan);
cannam@127: 	  pcost = FFTW(cost)(the_plan);
cannam@127: 	  if (verbose > 1) {
cannam@127: 	       FFTW(print_plan)(the_plan);
cannam@127: 	       printf("\n");
cannam@127: 	       printf("flops: %0.0f add, %0.0f mul, %0.0f fma\n",
cannam@127: 		      add, mul, nfma);
cannam@127: 	       printf("estimated cost: %f, pcost = %f\n", cost, pcost);
cannam@127: 	  }
cannam@127:      }
cannam@127: }
cannam@127: 
cannam@127: 
cannam@127: void doit(int iter, bench_problem *p)
cannam@127: {
cannam@127:      int i;
cannam@127:      FFTW(plan) q = the_plan;
cannam@127: 
cannam@127:      UNUSED(p);
cannam@127:      for (i = 0; i < iter; ++i) 
cannam@127: 	  FFTW(execute)(q);
cannam@127: }
cannam@127: 
cannam@127: void done(bench_problem *p)
cannam@127: {
cannam@127:      UNUSED(p);
cannam@127: 
cannam@127:      FFTW(destroy_plan)(the_plan);
cannam@127:      uninstall_hook();
cannam@127: }
cannam@127: 
cannam@127: void cleanup(void)
cannam@127: {
cannam@127:      initial_cleanup();
cannam@127: 
cannam@127:      wrwisdom();
cannam@127: #ifdef HAVE_SMP
cannam@127:      FFTW(cleanup_threads)();
cannam@127: #else
cannam@127:      FFTW(cleanup)();
cannam@127: #endif
cannam@127: 
cannam@127: #    ifdef FFTW_DEBUG_MALLOC
cannam@127:      {
cannam@127: 	  /* undocumented memory checker */
cannam@127: 	  FFTW_EXTERN void FFTW(malloc_print_minfo)(int v);
cannam@127: 	  FFTW(malloc_print_minfo)(verbose);
cannam@127:      }
cannam@127: #    endif
cannam@127: 
cannam@127:      final_cleanup();
cannam@127: }