cannam@167: /*
cannam@167:  * Copyright (c) 2003, 2007-14 Matteo Frigo
cannam@167:  * Copyright (c) 2003, 2007-14 Massachusetts Institute of Technology
cannam@167:  *
cannam@167:  * This program is free software; you can redistribute it and/or modify
cannam@167:  * it under the terms of the GNU General Public License as published by
cannam@167:  * the Free Software Foundation; either version 2 of the License, or
cannam@167:  * (at your option) any later version.
cannam@167:  *
cannam@167:  * This program is distributed in the hope that it will be useful,
cannam@167:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
cannam@167:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
cannam@167:  * GNU General Public License for more details.
cannam@167:  *
cannam@167:  * You should have received a copy of the GNU General Public License
cannam@167:  * along with this program; if not, write to the Free Software
cannam@167:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
cannam@167:  *
cannam@167:  */
cannam@167: 
cannam@167: #include "api/api.h"
cannam@167: 
cannam@167: static planner_hook_t before_planner_hook = 0, after_planner_hook = 0;
cannam@167: 
cannam@167: void X(set_planner_hooks)(planner_hook_t before, planner_hook_t after)
cannam@167: {
cannam@167:      before_planner_hook = before;
cannam@167:      after_planner_hook = after;
cannam@167: }
cannam@167: 
cannam@167: static plan *mkplan0(planner *plnr, unsigned flags,
cannam@167: 		     const problem *prb, unsigned hash_info,
cannam@167: 		     wisdom_state_t wisdom_state)
cannam@167: {
cannam@167:      /* map API flags into FFTW flags */
cannam@167:      X(mapflags)(plnr, flags);
cannam@167: 
cannam@167:      plnr->flags.hash_info = hash_info;
cannam@167:      plnr->wisdom_state = wisdom_state;
cannam@167: 
cannam@167:      /* create plan */
cannam@167:      return plnr->adt->mkplan(plnr, prb);
cannam@167: }
cannam@167: 
cannam@167: static unsigned force_estimator(unsigned flags)
cannam@167: {
cannam@167:      flags &= ~(FFTW_MEASURE | FFTW_PATIENT | FFTW_EXHAUSTIVE);
cannam@167:      return (flags | FFTW_ESTIMATE);
cannam@167: }
cannam@167: 
cannam@167: static plan *mkplan(planner *plnr, unsigned flags,
cannam@167: 		    const problem *prb, unsigned hash_info)
cannam@167: {
cannam@167:      plan *pln;
cannam@167:      
cannam@167:      pln = mkplan0(plnr, flags, prb, hash_info, WISDOM_NORMAL);
cannam@167: 
cannam@167:      if (plnr->wisdom_state == WISDOM_NORMAL && !pln) {
cannam@167: 	  /* maybe the planner failed because of inconsistent wisdom;
cannam@167: 	     plan again ignoring infeasible wisdom */
cannam@167: 	  pln = mkplan0(plnr, force_estimator(flags), prb,
cannam@167: 			hash_info, WISDOM_IGNORE_INFEASIBLE);
cannam@167:      }
cannam@167: 
cannam@167:      if (plnr->wisdom_state == WISDOM_IS_BOGUS) {
cannam@167: 	  /* if the planner detected a wisdom inconsistency,
cannam@167: 	     forget all wisdom and plan again */
cannam@167: 	  plnr->adt->forget(plnr, FORGET_EVERYTHING);
cannam@167: 
cannam@167: 	  A(!pln);
cannam@167: 	  pln = mkplan0(plnr, flags, prb, hash_info, WISDOM_NORMAL);
cannam@167: 
cannam@167: 	  if (plnr->wisdom_state == WISDOM_IS_BOGUS) {
cannam@167: 	       /* if it still fails, plan without wisdom */
cannam@167: 	       plnr->adt->forget(plnr, FORGET_EVERYTHING);
cannam@167: 
cannam@167: 	       A(!pln);
cannam@167: 	       pln = mkplan0(plnr, force_estimator(flags),
cannam@167: 			     prb, hash_info, WISDOM_IGNORE_ALL);
cannam@167: 	  }
cannam@167:      }
cannam@167: 
cannam@167:      return pln;
cannam@167: }
cannam@167: 
cannam@167: apiplan *X(mkapiplan)(int sign, unsigned flags, problem *prb)
cannam@167: {
cannam@167:      apiplan *p = 0;
cannam@167:      plan *pln;
cannam@167:      unsigned flags_used_for_planning;
cannam@167:      planner *plnr;
cannam@167:      static const unsigned int pats[] = {FFTW_ESTIMATE, FFTW_MEASURE,
cannam@167:                                          FFTW_PATIENT, FFTW_EXHAUSTIVE};
cannam@167:      int pat, pat_max;
cannam@167:      double pcost = 0;
cannam@167:      
cannam@167:      if (before_planner_hook)
cannam@167:           before_planner_hook();
cannam@167:      
cannam@167:      plnr = X(the_planner)();
cannam@167: 
cannam@167:      if (flags & FFTW_WISDOM_ONLY) {
cannam@167: 	  /* Special mode that returns a plan only if wisdom is present,
cannam@167: 	     and returns 0 otherwise.  This is now documented in the manual,
cannam@167: 	     as a way to detect whether wisdom is available for a problem. */
cannam@167: 	  flags_used_for_planning = flags;
cannam@167: 	  pln = mkplan0(plnr, flags, prb, 0, WISDOM_ONLY);
cannam@167:      } else {
cannam@167: 	  pat_max = flags & FFTW_ESTIMATE ? 0 :
cannam@167: 	       (flags & FFTW_EXHAUSTIVE ? 3 :
cannam@167: 		(flags & FFTW_PATIENT ? 2 : 1));
cannam@167: 	  pat = plnr->timelimit >= 0 ? 0 : pat_max;
cannam@167: 
cannam@167: 	  flags &= ~(FFTW_ESTIMATE | FFTW_MEASURE |
cannam@167: 		     FFTW_PATIENT | FFTW_EXHAUSTIVE);
cannam@167: 
cannam@167: 	  plnr->start_time = X(get_crude_time)();
cannam@167: 
cannam@167: 	  /* plan at incrementally increasing patience until we run
cannam@167: 	     out of time */
cannam@167: 	  for (pln = 0, flags_used_for_planning = 0; pat <= pat_max; ++pat) {
cannam@167: 	       plan *pln1;
cannam@167: 	       unsigned tmpflags = flags | pats[pat];
cannam@167: 	       pln1 = mkplan(plnr, tmpflags, prb, 0u);
cannam@167: 
cannam@167: 	       if (!pln1) {
cannam@167: 		    /* don't bother continuing if planner failed or timed out */
cannam@167: 		    A(!pln || plnr->timed_out);
cannam@167: 		    break;
cannam@167: 	       }
cannam@167: 
cannam@167: 	       X(plan_destroy_internal)(pln);
cannam@167: 	       pln = pln1;
cannam@167: 	       flags_used_for_planning = tmpflags;
cannam@167: 	       pcost = pln->pcost;
cannam@167: 	  }
cannam@167:      }
cannam@167: 
cannam@167:      if (pln) {
cannam@167: 	  /* build apiplan */
cannam@167: 	  p = (apiplan *) MALLOC(sizeof(apiplan), PLANS);
cannam@167: 	  p->prb = prb;
cannam@167: 	  p->sign = sign; /* cache for execute_dft */
cannam@167: 
cannam@167: 	  /* re-create plan from wisdom, adding blessing */
cannam@167: 	  p->pln = mkplan(plnr, flags_used_for_planning, prb, BLESSING);
cannam@167: 
cannam@167: 	  /* record pcost from most recent measurement for use in X(cost) */
cannam@167: 	  p->pln->pcost = pcost;
cannam@167: 
cannam@167: 	  if (sizeof(trigreal) > sizeof(R)) {
cannam@167: 	       /* this is probably faster, and we have enough trigreal
cannam@167: 		  bits to maintain accuracy */
cannam@167: 	       X(plan_awake)(p->pln, AWAKE_SQRTN_TABLE);
cannam@167: 	  } else {
cannam@167: 	       /* more accurate */
cannam@167: 	       X(plan_awake)(p->pln, AWAKE_SINCOS);
cannam@167: 	  }
cannam@167: 
cannam@167: 	  /* we don't use pln for p->pln, above, since by re-creating the
cannam@167: 	     plan we might use more patient wisdom from a timed-out mkplan */
cannam@167: 	  X(plan_destroy_internal)(pln);
cannam@167:      } else
cannam@167: 	  X(problem_destroy)(prb);
cannam@167: 
cannam@167:      /* discard all information not necessary to reconstruct the plan */
cannam@167:      plnr->adt->forget(plnr, FORGET_ACCURSED);
cannam@167: 
cannam@167: #ifdef FFTW_RANDOM_ESTIMATOR
cannam@167:      X(random_estimate_seed)++; /* subsequent "random" plans are distinct */
cannam@167: #endif
cannam@167: 
cannam@167:      if (after_planner_hook)
cannam@167:           after_planner_hook();
cannam@167:      
cannam@167:      return p;
cannam@167: }
cannam@167: 
cannam@167: void X(destroy_plan)(X(plan) p)
cannam@167: {
cannam@167:      if (p) {
cannam@167:           if (before_planner_hook)
cannam@167:                before_planner_hook();
cannam@167:      
cannam@167:           X(plan_awake)(p->pln, SLEEPY);
cannam@167:           X(plan_destroy_internal)(p->pln);
cannam@167:           X(problem_destroy)(p->prb);
cannam@167:           X(ifree)(p);
cannam@167: 
cannam@167:           if (after_planner_hook)
cannam@167:                after_planner_hook();
cannam@167:      }
cannam@167: }
cannam@167: 
cannam@167: int X(alignment_of)(R *p)
cannam@167: {
cannam@167:      return X(ialignment_of(p));
cannam@167: }