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: /* Complex DFTs of rank == 1 when the vector length vn is >= # processes.
cannam@127:    In this case, we don't need to use a six-step type algorithm, and can
cannam@127:    instead transpose the DFT dimension with the vector dimension to 
cannam@127:    make the DFT local. */
cannam@127: 
cannam@127: #include "mpi-dft.h"
cannam@127: #include "mpi-transpose.h"
cannam@127: #include "dft.h"
cannam@127: 
cannam@127: typedef struct {
cannam@127:      solver super;
cannam@127:      int preserve_input; /* preserve input even if DESTROY_INPUT was passed */
cannam@127:      rearrangement rearrange;
cannam@127: } S;
cannam@127: 
cannam@127: typedef struct {
cannam@127:      plan_mpi_dft super;
cannam@127: 
cannam@127:      plan *cldt_before, *cld, *cldt_after;
cannam@127:      INT roff, ioff;
cannam@127:      int preserve_input;
cannam@127:      rearrangement rearrange;
cannam@127: } P;
cannam@127: 
cannam@127: static void apply(const plan *ego_, R *I, R *O)
cannam@127: {
cannam@127:      const P *ego = (const P *) ego_;
cannam@127:      plan_dft *cld;
cannam@127:      plan_rdft *cldt_before, *cldt_after;
cannam@127:      INT roff = ego->roff, ioff = ego->ioff;
cannam@127:      
cannam@127:      /* global transpose */
cannam@127:      cldt_before = (plan_rdft *) ego->cldt_before;
cannam@127:      cldt_before->apply(ego->cldt_before, I, O);
cannam@127:      
cannam@127:      if (ego->preserve_input) I = O;
cannam@127: 	  
cannam@127:      /* 1d DFT(s) */
cannam@127:      cld = (plan_dft *) ego->cld;
cannam@127:      cld->apply(ego->cld, O+roff, O+ioff, I+roff, I+ioff);
cannam@127:      
cannam@127:      /* global transpose */
cannam@127:      cldt_after = (plan_rdft *) ego->cldt_after;
cannam@127:      cldt_after->apply(ego->cldt_after, I, O);
cannam@127: }
cannam@127: 
cannam@127: static int applicable(const S *ego, const problem *p_,
cannam@127: 		      const planner *plnr)
cannam@127: {
cannam@127:      const problem_mpi_dft *p = (const problem_mpi_dft *) p_;
cannam@127:      int n_pes;
cannam@127:      MPI_Comm_size(p->comm, &n_pes);
cannam@127:      return (1
cannam@127: 	     && p->sz->rnk == 1
cannam@127: 	     && !(p->flags & ~RANK1_BIGVEC_ONLY)
cannam@127: 	     && (!ego->preserve_input || (!NO_DESTROY_INPUTP(plnr)
cannam@127: 					  && p->I != p->O))
cannam@127: 	     && (p->vn >= n_pes /* TODO: relax this, using more memory? */
cannam@127: 		 || (p->flags & RANK1_BIGVEC_ONLY))
cannam@127: 
cannam@127: 	     && XM(rearrange_applicable)(ego->rearrange,
cannam@127: 					 p->sz->dims[0], p->vn, n_pes)
cannam@127: 
cannam@127: 	     && (!NO_SLOWP(plnr) /* slow if dft-serial is applicable */
cannam@127:                  || !XM(dft_serial_applicable)(p))
cannam@127: 	  );
cannam@127: }
cannam@127: 
cannam@127: static void awake(plan *ego_, enum wakefulness wakefulness)
cannam@127: {
cannam@127:      P *ego = (P *) ego_;
cannam@127:      X(plan_awake)(ego->cldt_before, wakefulness);
cannam@127:      X(plan_awake)(ego->cld, wakefulness);
cannam@127:      X(plan_awake)(ego->cldt_after, wakefulness);
cannam@127: }
cannam@127: 
cannam@127: static void destroy(plan *ego_)
cannam@127: {
cannam@127:      P *ego = (P *) ego_;
cannam@127:      X(plan_destroy_internal)(ego->cldt_after);
cannam@127:      X(plan_destroy_internal)(ego->cld);
cannam@127:      X(plan_destroy_internal)(ego->cldt_before);
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 char descrip[][16] = { "contig", "discontig", "square-after",
cannam@127: 				  "square-middle", "square-before" };
cannam@127:      p->print(p, "(mpi-dft-rank1-bigvec/%s%s %(%p%) %(%p%) %(%p%))",
cannam@127: 	      descrip[ego->rearrange], ego->preserve_input==2 ?"/p":"",
cannam@127: 	      ego->cldt_before, ego->cld, ego->cldt_after);
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:      const problem_mpi_dft *p;
cannam@127:      P *pln;
cannam@127:      plan *cld = 0, *cldt_before = 0, *cldt_after = 0;
cannam@127:      R *ri, *ii, *ro, *io, *I, *O;
cannam@127:      INT yblock, yb, nx, ny, vn;
cannam@127:      int my_pe, n_pes;
cannam@127:      static const plan_adt padt = {
cannam@127:           XM(dft_solve), awake, print, destroy
cannam@127:      };
cannam@127: 
cannam@127:      UNUSED(ego);
cannam@127: 
cannam@127:      if (!applicable(ego, p_, plnr))
cannam@127:           return (plan *) 0;
cannam@127: 
cannam@127:      p = (const problem_mpi_dft *) p_;
cannam@127: 
cannam@127:      MPI_Comm_rank(p->comm, &my_pe);
cannam@127:      MPI_Comm_size(p->comm, &n_pes);
cannam@127:      
cannam@127:      nx = p->sz->dims[0].n;
cannam@127:      if (!(ny = XM(rearrange_ny)(ego->rearrange, p->sz->dims[0],p->vn,n_pes)))
cannam@127: 	  return (plan *) 0;
cannam@127:      vn = p->vn / ny;
cannam@127:      A(ny * vn == p->vn);
cannam@127: 
cannam@127:      yblock = XM(default_block)(ny, n_pes);
cannam@127:      cldt_before = X(mkplan_d)(plnr,
cannam@127: 			       XM(mkproblem_transpose)(
cannam@127: 				    nx, ny, vn*2,
cannam@127: 				    I = p->I, O = p->O,
cannam@127: 				    p->sz->dims[0].b[IB], yblock,
cannam@127: 				    p->comm, 0));
cannam@127:      if (XM(any_true)(!cldt_before, p->comm)) goto nada;	  
cannam@127:      if (ego->preserve_input || NO_DESTROY_INPUTP(plnr)) { I = O; }
cannam@127:      
cannam@127:      X(extract_reim)(p->sign, I, &ri, &ii);
cannam@127:      X(extract_reim)(p->sign, O, &ro, &io);
cannam@127: 
cannam@127:      yb = XM(block)(ny, yblock, my_pe);
cannam@127:      cld = X(mkplan_d)(plnr,
cannam@127: 		       X(mkproblem_dft_d)(X(mktensor_1d)(nx, vn*2, vn*2),
cannam@127: 					  X(mktensor_2d)(yb, vn*2*nx, vn*2*nx,
cannam@127: 							 vn, 2, 2),
cannam@127: 					  ro, io, ri, ii));
cannam@127:      if (XM(any_true)(!cld, p->comm)) goto nada;	  
cannam@127:      
cannam@127:      cldt_after = X(mkplan_d)(plnr,
cannam@127: 			      XM(mkproblem_transpose)(
cannam@127: 				   ny, nx, vn*2,
cannam@127: 				   I, O,
cannam@127: 				   yblock, p->sz->dims[0].b[OB], 
cannam@127: 				   p->comm, 0));
cannam@127:      if (XM(any_true)(!cldt_after, p->comm)) goto nada;	  
cannam@127: 
cannam@127:      pln = MKPLAN_MPI_DFT(P, &padt, apply);
cannam@127: 
cannam@127:      pln->cldt_before = cldt_before;
cannam@127:      pln->cld = cld;
cannam@127:      pln->cldt_after = cldt_after;
cannam@127:      pln->preserve_input = ego->preserve_input ? 2 : NO_DESTROY_INPUTP(plnr);
cannam@127:      pln->roff = ro - p->O;
cannam@127:      pln->ioff = io - p->O;
cannam@127:      pln->rearrange = ego->rearrange;
cannam@127: 
cannam@127:      X(ops_add)(&cldt_before->ops, &cld->ops, &pln->super.super.ops);
cannam@127:      X(ops_add2)(&cldt_after->ops, &pln->super.super.ops);
cannam@127: 
cannam@127:      return &(pln->super.super);
cannam@127: 
cannam@127:  nada:
cannam@127:      X(plan_destroy_internal)(cldt_after);
cannam@127:      X(plan_destroy_internal)(cld);
cannam@127:      X(plan_destroy_internal)(cldt_before);
cannam@127:      return (plan *) 0;
cannam@127: }
cannam@127: 
cannam@127: static solver *mksolver(rearrangement rearrange, int preserve_input)
cannam@127: {
cannam@127:      static const solver_adt sadt = { PROBLEM_MPI_DFT, mkplan, 0 };
cannam@127:      S *slv = MKSOLVER(S, &sadt);
cannam@127:      slv->rearrange = rearrange;
cannam@127:      slv->preserve_input = preserve_input;
cannam@127:      return &(slv->super);
cannam@127: }
cannam@127: 
cannam@127: void XM(dft_rank1_bigvec_register)(planner *p)
cannam@127: {
cannam@127:      rearrangement rearrange;
cannam@127:      int preserve_input;
cannam@127:      FORALL_REARRANGE(rearrange)
cannam@127: 	  for (preserve_input = 0; preserve_input <= 1; ++preserve_input)
cannam@127: 	       REGISTER_SOLVER(p, mksolver(rearrange, preserve_input));
cannam@127: }