cannam@127: /*
cannam@127:  * Copyright (c) 2003, 2007-14 Matteo Frigo
cannam@127:  * Copyright (c) 2003, 2007-14 Massachusetts Institute of Technology
cannam@127:  *
cannam@127:  * This program is free software; you can redistribute it and/or modify
cannam@127:  * it under the terms of the GNU General Public License as published by
cannam@127:  * the Free Software Foundation; either version 2 of the License, or
cannam@127:  * (at your option) any later version.
cannam@127:  *
cannam@127:  * This program is distributed in the hope that it will be useful,
cannam@127:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
cannam@127:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
cannam@127:  * GNU General Public License for more details.
cannam@127:  *
cannam@127:  * You should have received a copy of the GNU General Public License
cannam@127:  * along with this program; if not, write to the Free Software
cannam@127:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
cannam@127:  *
cannam@127:  */
cannam@127: 
cannam@127: 
cannam@127: /* direct DFT solver, if we have a codelet */
cannam@127: 
cannam@127: #include "dft.h"
cannam@127: 
cannam@127: typedef struct {
cannam@127:      solver super;
cannam@127:      const kdft_desc *desc;
cannam@127:      kdft k;
cannam@127:      int bufferedp;
cannam@127: } S;
cannam@127: 
cannam@127: typedef struct {
cannam@127:      plan_dft super;
cannam@127: 
cannam@127:      stride is, os, bufstride;
cannam@127:      INT n, vl, ivs, ovs;
cannam@127:      kdft k;
cannam@127:      const S *slv;
cannam@127: } P;
cannam@127: 
cannam@127: static void dobatch(const P *ego, R *ri, R *ii, R *ro, R *io, 
cannam@127: 		    R *buf, INT batchsz)
cannam@127: {
cannam@127:      X(cpy2d_pair_ci)(ri, ii, buf, buf+1,
cannam@127: 		      ego->n, WS(ego->is, 1), WS(ego->bufstride, 1),
cannam@127: 		      batchsz, ego->ivs, 2);
cannam@127:      
cannam@127:      if (IABS(WS(ego->os, 1)) < IABS(ego->ovs)) {
cannam@127: 	  /* transform directly to output */
cannam@127: 	  ego->k(buf, buf+1, ro, io, 
cannam@127: 		 ego->bufstride, ego->os, batchsz, 2, ego->ovs);
cannam@127:      } else {
cannam@127: 	  /* transform to buffer and copy back */
cannam@127: 	  ego->k(buf, buf+1, buf, buf+1, 
cannam@127: 		 ego->bufstride, ego->bufstride, batchsz, 2, 2);
cannam@127: 	  X(cpy2d_pair_co)(buf, buf+1, ro, io,
cannam@127: 			   ego->n, WS(ego->bufstride, 1), WS(ego->os, 1), 
cannam@127: 			   batchsz, 2, ego->ovs);
cannam@127:      }
cannam@127: }
cannam@127: 
cannam@127: static INT compute_batchsize(INT n)
cannam@127: {
cannam@127:      /* round up to multiple of 4 */
cannam@127:      n += 3;
cannam@127:      n &= -4;
cannam@127: 
cannam@127:      return (n + 2);
cannam@127: }
cannam@127: 
cannam@127: static void apply_buf(const plan *ego_, R *ri, R *ii, R *ro, R *io)
cannam@127: {
cannam@127:      const P *ego = (const P *) ego_;
cannam@127:      R *buf;
cannam@127:      INT vl = ego->vl, n = ego->n, batchsz = compute_batchsize(n);
cannam@127:      INT i;
cannam@127:      size_t bufsz = n * batchsz * 2 * sizeof(R);
cannam@127: 
cannam@127:      BUF_ALLOC(R *, buf, bufsz);
cannam@127: 
cannam@127:      for (i = 0; i < vl - batchsz; i += batchsz) {
cannam@127: 	  dobatch(ego, ri, ii, ro, io, buf, batchsz);
cannam@127: 	  ri += batchsz * ego->ivs; ii += batchsz * ego->ivs;
cannam@127: 	  ro += batchsz * ego->ovs; io += batchsz * ego->ovs;
cannam@127:      }
cannam@127:      dobatch(ego, ri, ii, ro, io, buf, vl - i);
cannam@127: 
cannam@127:      BUF_FREE(buf, bufsz);
cannam@127: }
cannam@127: 
cannam@127: static void apply(const plan *ego_, R *ri, R *ii, R *ro, R *io)
cannam@127: {
cannam@127:      const P *ego = (const P *) ego_;
cannam@127:      ASSERT_ALIGNED_DOUBLE;
cannam@127:      ego->k(ri, ii, ro, io, ego->is, ego->os, ego->vl, ego->ivs, ego->ovs);
cannam@127: }
cannam@127: 
cannam@127: static void apply_extra_iter(const plan *ego_, R *ri, R *ii, R *ro, R *io)
cannam@127: {
cannam@127:      const P *ego = (const P *) ego_;
cannam@127:      INT vl = ego->vl;
cannam@127: 
cannam@127:      ASSERT_ALIGNED_DOUBLE;
cannam@127: 
cannam@127:      /* for 4-way SIMD when VL is odd: iterate over an
cannam@127: 	even vector length VL, and then execute the last
cannam@127: 	iteration as a 2-vector with vector stride 0. */
cannam@127:      ego->k(ri, ii, ro, io, ego->is, ego->os, vl - 1, ego->ivs, ego->ovs);
cannam@127: 
cannam@127:      ego->k(ri + (vl - 1) * ego->ivs, ii + (vl - 1) * ego->ivs,
cannam@127: 	    ro + (vl - 1) * ego->ovs, io + (vl - 1) * ego->ovs,
cannam@127: 	    ego->is, ego->os, 1, 0, 0);
cannam@127: }
cannam@127: 
cannam@127: static void destroy(plan *ego_)
cannam@127: {
cannam@127:      P *ego = (P *) ego_;
cannam@127:      X(stride_destroy)(ego->is);
cannam@127:      X(stride_destroy)(ego->os);
cannam@127:      X(stride_destroy)(ego->bufstride);
cannam@127: }
cannam@127: 
cannam@127: static void print(const plan *ego_, printer *p)
cannam@127: {
cannam@127:      const P *ego = (const P *) ego_;
cannam@127:      const S *s = ego->slv;
cannam@127:      const kdft_desc *d = s->desc;
cannam@127: 
cannam@127:      if (ego->slv->bufferedp)
cannam@127: 	  p->print(p, "(dft-directbuf/%D-%D%v \"%s\")", 
cannam@127: 		   compute_batchsize(d->sz), d->sz, ego->vl, d->nam);
cannam@127:      else
cannam@127: 	  p->print(p, "(dft-direct-%D%v \"%s\")", d->sz, ego->vl, d->nam);
cannam@127: }
cannam@127: 
cannam@127: static int applicable_buf(const solver *ego_, const problem *p_,
cannam@127: 			  const planner *plnr)
cannam@127: {
cannam@127:      const S *ego = (const S *) ego_;
cannam@127:      const problem_dft *p = (const problem_dft *) p_;
cannam@127:      const kdft_desc *d = ego->desc;
cannam@127:      INT vl;
cannam@127:      INT ivs, ovs;
cannam@127:      INT batchsz;
cannam@127: 
cannam@127:      return (
cannam@127: 	  1
cannam@127: 	  && p->sz->rnk == 1
cannam@127: 	  && p->vecsz->rnk == 1
cannam@127: 	  && p->sz->dims[0].n == d->sz
cannam@127: 
cannam@127: 	  /* check strides etc */
cannam@127: 	  && X(tensor_tornk1)(p->vecsz, &vl, &ivs, &ovs)
cannam@127: 
cannam@127: 	  /* UGLY if IS <= IVS */
cannam@127: 	  && !(NO_UGLYP(plnr) &&
cannam@127: 	       X(iabs)(p->sz->dims[0].is) <= X(iabs)(ivs))
cannam@127: 
cannam@127: 	  && (batchsz = compute_batchsize(d->sz), 1)
cannam@127: 	  && (d->genus->okp(d, 0, ((const R *)0) + 1, p->ro, p->io,
cannam@127: 			    2 * batchsz, p->sz->dims[0].os,
cannam@127: 			    batchsz, 2, ovs, plnr))
cannam@127: 	  && (d->genus->okp(d, 0, ((const R *)0) + 1, p->ro, p->io,
cannam@127: 			    2 * batchsz, p->sz->dims[0].os,
cannam@127: 			    vl % batchsz, 2, ovs, plnr))
cannam@127: 
cannam@127: 
cannam@127: 	  && (0
cannam@127: 	      /* can operate out-of-place */
cannam@127: 	      || p->ri != p->ro
cannam@127: 
cannam@127: 	      /* can operate in-place as long as strides are the same */
cannam@127: 	      || X(tensor_inplace_strides2)(p->sz, p->vecsz)
cannam@127: 
cannam@127: 	      /* can do it if the problem fits in the buffer, no matter
cannam@127: 		 what the strides are */
cannam@127: 	      || vl <= batchsz
cannam@127: 	       )
cannam@127: 	  );
cannam@127: }
cannam@127: 
cannam@127: static int applicable(const solver *ego_, const problem *p_,
cannam@127: 		      const planner *plnr, int *extra_iterp)
cannam@127: {
cannam@127:      const S *ego = (const S *) ego_;
cannam@127:      const problem_dft *p = (const problem_dft *) p_;
cannam@127:      const kdft_desc *d = ego->desc;
cannam@127:      INT vl;
cannam@127:      INT ivs, ovs;
cannam@127: 
cannam@127:      return (
cannam@127: 	  1
cannam@127: 	  && p->sz->rnk == 1
cannam@127: 	  && p->vecsz->rnk <= 1
cannam@127: 	  && p->sz->dims[0].n == d->sz
cannam@127: 
cannam@127: 	  /* check strides etc */
cannam@127: 	  && X(tensor_tornk1)(p->vecsz, &vl, &ivs, &ovs)
cannam@127: 
cannam@127: 	  && ((*extra_iterp = 0,
cannam@127: 	       (d->genus->okp(d, p->ri, p->ii, p->ro, p->io,
cannam@127: 			      p->sz->dims[0].is, p->sz->dims[0].os,
cannam@127: 			      vl, ivs, ovs, plnr)))
cannam@127: 	      ||
cannam@127: 	      (*extra_iterp = 1,
cannam@127: 	       ((d->genus->okp(d, p->ri, p->ii, p->ro, p->io,
cannam@127: 			       p->sz->dims[0].is, p->sz->dims[0].os,
cannam@127: 			       vl - 1, ivs, ovs, plnr))
cannam@127: 		&&
cannam@127: 		(d->genus->okp(d, p->ri, p->ii, p->ro, p->io,
cannam@127: 			       p->sz->dims[0].is, p->sz->dims[0].os,
cannam@127: 			       2, 0, 0, plnr)))))
cannam@127: 
cannam@127: 	  && (0
cannam@127: 	      /* can operate out-of-place */
cannam@127: 	      || p->ri != p->ro
cannam@127: 
cannam@127: 	      /* can always compute one transform */
cannam@127: 	      || vl == 1
cannam@127: 
cannam@127: 	      /* can operate in-place as long as strides are the same */
cannam@127: 	      || X(tensor_inplace_strides2)(p->sz, p->vecsz)
cannam@127: 	       )
cannam@127: 	  );
cannam@127: }
cannam@127: 
cannam@127: 
cannam@127: static plan *mkplan(const solver *ego_, const problem *p_, planner *plnr)
cannam@127: {
cannam@127:      const S *ego = (const S *) ego_;
cannam@127:      P *pln;
cannam@127:      const problem_dft *p;
cannam@127:      iodim *d;
cannam@127:      const kdft_desc *e = ego->desc;
cannam@127: 
cannam@127:      static const plan_adt padt = {
cannam@127: 	  X(dft_solve), X(null_awake), print, destroy
cannam@127:      };
cannam@127: 
cannam@127:      UNUSED(plnr);
cannam@127: 
cannam@127:      if (ego->bufferedp) {
cannam@127: 	  if (!applicable_buf(ego_, p_, plnr))
cannam@127: 	       return (plan *)0;
cannam@127: 	  pln = MKPLAN_DFT(P, &padt, apply_buf);
cannam@127:      } else {
cannam@127: 	  int extra_iterp = 0;
cannam@127: 	  if (!applicable(ego_, p_, plnr, &extra_iterp))
cannam@127: 	       return (plan *)0;
cannam@127: 	  pln = MKPLAN_DFT(P, &padt, extra_iterp ? apply_extra_iter : apply);
cannam@127:      }
cannam@127: 
cannam@127:      p = (const problem_dft *) p_;
cannam@127:      d = p->sz->dims;
cannam@127:      pln->k = ego->k;
cannam@127:      pln->n = d[0].n;
cannam@127:      pln->is = X(mkstride)(pln->n, d[0].is);
cannam@127:      pln->os = X(mkstride)(pln->n, d[0].os);
cannam@127:      pln->bufstride = X(mkstride)(pln->n, 2 * compute_batchsize(pln->n));
cannam@127: 
cannam@127:      X(tensor_tornk1)(p->vecsz, &pln->vl, &pln->ivs, &pln->ovs);
cannam@127:      pln->slv = ego;
cannam@127: 
cannam@127:      X(ops_zero)(&pln->super.super.ops);
cannam@127:      X(ops_madd2)(pln->vl / e->genus->vl, &e->ops, &pln->super.super.ops);
cannam@127: 
cannam@127:      if (ego->bufferedp) 
cannam@127: 	  pln->super.super.ops.other += 4 * pln->n * pln->vl;
cannam@127: 
cannam@127:      pln->super.super.could_prune_now_p = !ego->bufferedp;
cannam@127:      return &(pln->super.super);
cannam@127: }
cannam@127: 
cannam@127: static solver *mksolver(kdft k, const kdft_desc *desc, int bufferedp)
cannam@127: {
cannam@127:      static const solver_adt sadt = { PROBLEM_DFT, mkplan, 0 };
cannam@127:      S *slv = MKSOLVER(S, &sadt);
cannam@127:      slv->k = k;
cannam@127:      slv->desc = desc;
cannam@127:      slv->bufferedp = bufferedp;
cannam@127:      return &(slv->super);
cannam@127: }
cannam@127: 
cannam@127: solver *X(mksolver_dft_direct)(kdft k, const kdft_desc *desc)
cannam@127: {
cannam@127:      return mksolver(k, desc, 0);
cannam@127: }
cannam@127: 
cannam@127: solver *X(mksolver_dft_directbuf)(kdft k, const kdft_desc *desc)
cannam@127: {
cannam@127:      return mksolver(k, desc, 1);
cannam@127: }