src/gromacs/mdlib/nbnxn_internal.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35
  36 #ifndef _nbnxn_internal_h
  37 #define _nbnxn_internal_h
  38
  39 #include "typedefs.h"
  40 #include "nbnxn_simd.h"
  41 #include "domdec.h"
  42 #include "gromacs/timing/cyclecounter.h"
  43
  44
  45 /* Bounding box calculations are (currently) always in single precision, so
  46  * we only need to check for single precision support here.
  47  * This uses less (cache-)memory and SIMD is faster, at least on x86.
  48  */
  49 #ifdef GMX_SIMD4_HAVE_FLOAT
  50 #define NBNXN_SEARCH_BB_SIMD4
  51 #endif
  52
  53
  54 #ifdef __cplusplus
  55 extern "C" {
  56 #endif
  57
  58
  59 #ifdef GMX_NBNXN_SIMD
  60 /* Memory alignment in bytes as required by SIMD aligned loads/stores */
  61 #define NBNXN_MEM_ALIGN  (GMX_SIMD_REAL_WIDTH*sizeof(real))
  62 #else
  63 /* No alignment required, but set it so we can call the same routines */
  64 #define NBNXN_MEM_ALIGN  32
  65 #endif
  66
  67
  68 #ifdef NBNXN_SEARCH_BB_SIMD4
  69 /* Memory alignment in bytes as required by SIMD aligned loads/stores */
  70 #define NBNXN_SEARCH_BB_MEM_ALIGN  (GMX_SIMD4_WIDTH*sizeof(float))
  71 #else
  72 /* No alignment required, but set it so we can call the same routines */
  73 #define NBNXN_SEARCH_BB_MEM_ALIGN  32
  74 #endif
  75
  76
  77 /* Pair search box lower and upper corner in x,y,z.
  78  * Store this in 4 iso 3 reals, which is useful with 4-wide SIMD.
  79  * To avoid complicating the code we also use 4 without 4-wide SIMD.
  80  */
  81 #define NNBSBB_C         4
  82 /* Pair search box lower and upper bound in z only. */
  83 #define NNBSBB_D         2
  84 /* Pair search box lower and upper corner x,y,z indices, entry 3 is unused */
  85 #define BB_X  0
  86 #define BB_Y  1
  87 #define BB_Z  2
  88
  89 /* Bounding box for a nbnxn atom cluster */
  90 typedef struct {
  91     float lower[NNBSBB_C];
  92     float upper[NNBSBB_C];
  93 } nbnxn_bb_t;
  94
  95
  96 /* A pair-search grid struct for one domain decomposition zone */
  97 typedef struct {
  98     rvec          c0;               /* The lower corner of the (local) grid        */
  99     rvec          c1;               /* The upper corner of the (local) grid        */
 100     real          atom_density;     /* The atom number density for the local grid  */
 101
 102     gmx_bool      bSimple;          /* Is this grid simple or super/sub            */
 103     int           na_c;             /* Number of atoms per cluster                 */
 104     int           na_cj;            /* Number of atoms for list j-clusters         */
 105     int           na_sc;            /* Number of atoms per super-cluster           */
 106     int           na_c_2log;        /* 2log of na_c                                */
 107
 108     int           ncx;              /* Number of (super-)cells along x             */
 109     int           ncy;              /* Number of (super-)cells along y             */
 110     int           nc;               /* Total number of (super-)cells               */
 111
 112     real          sx;               /* x-size of a (super-)cell                    */
 113     real          sy;               /* y-size of a (super-)cell                    */
 114     real          inv_sx;           /* 1/sx                                        */
 115     real          inv_sy;           /* 1/sy                                        */
 116
 117     int           cell0;            /* Index in nbs->cell corresponding to cell 0  */
 118
 119     int          *cxy_na;           /* The number of atoms for each column in x,y  */
 120     int          *cxy_ind;          /* Grid (super)cell index, offset from cell0   */
 121     int           cxy_nalloc;       /* Allocation size for cxy_na and cxy_ind      */
 122
 123     int          *nsubc;            /* The number of sub cells for each super cell */
 124     float        *bbcz;             /* Bounding boxes in z for the super cells     */
 125     nbnxn_bb_t   *bb;               /* 3D bounding boxes for the sub cells         */
 126     nbnxn_bb_t   *bbj;              /* 3D j-bounding boxes for the case where      *
 127                                      * the i- and j-cluster sizes are different    */
 128     float        *pbb;              /* 3D b. boxes in xxxx format per super cell   */
 129     int          *flags;            /* Flag for the super cells                    */
 130     unsigned int *fep;              /* FEP signal bits for sub cells               */
 131     int           nc_nalloc;        /* Allocation size for the pointers above      */
 132
 133     float        *bbcz_simple;      /* bbcz for simple grid converted from super   */
 134     nbnxn_bb_t   *bb_simple;        /* bb for simple grid converted from super     */
 135     int          *flags_simple;     /* flags for simple grid converted from super  */
 136     int           nc_nalloc_simple; /* Allocation size for the pointers above   */
 137
 138     int           nsubc_tot;        /* Total number of subcell, used for printing  */
 139 } nbnxn_grid_t;
 140
 141 #ifdef GMX_NBNXN_SIMD
 142
 143 typedef struct nbnxn_x_ci_simd_4xn {
 144     /* The i-cluster coordinates for simple search */
 145     gmx_simd_real_t ix_S0, iy_S0, iz_S0;
 146     gmx_simd_real_t ix_S1, iy_S1, iz_S1;
 147     gmx_simd_real_t ix_S2, iy_S2, iz_S2;
 148     gmx_simd_real_t ix_S3, iy_S3, iz_S3;
 149 } nbnxn_x_ci_simd_4xn_t;
 150
 151 typedef struct nbnxn_x_ci_simd_2xnn {
 152     /* The i-cluster coordinates for simple search */
 153     gmx_simd_real_t ix_S0, iy_S0, iz_S0;
 154     gmx_simd_real_t ix_S2, iy_S2, iz_S2;
 155 } nbnxn_x_ci_simd_2xnn_t;
 156
 157 #endif
 158
 159 /* Working data for the actual i-supercell during pair search */
 160 typedef struct nbnxn_list_work {
 161     gmx_cache_protect_t     cp0;    /* Protect cache between threads               */
 162
 163     nbnxn_bb_t             *bb_ci;  /* The bounding boxes, pbc shifted, for each cluster */
 164     float                  *pbb_ci; /* As bb_ci, but in xxxx packed format               */
 165     real                   *x_ci;   /* The coordinates, pbc shifted, for each atom       */
 166 #ifdef GMX_NBNXN_SIMD
 167     nbnxn_x_ci_simd_4xn_t  *x_ci_simd_4xn;
 168     nbnxn_x_ci_simd_2xnn_t *x_ci_simd_2xnn;
 169 #endif
 170     int                     cj_ind;          /* The current cj_ind index for the current list     */
 171     int                     cj4_init;        /* The first unitialized cj4 block                   */
 172
 173     float                  *d2;              /* Bounding box distance work array                  */
 174
 175     nbnxn_cj_t             *cj;              /* The j-cell list                                   */
 176     int                     cj_nalloc;       /* Allocation size of cj                             */
 177
 178     int                     ncj_noq;         /* Nr. of cluster pairs without Coul for flop count  */
 179     int                     ncj_hlj;         /* Nr. of cluster pairs with 1/2 LJ for flop count   */
 180
 181     int                    *sort;            /* Sort index                    */
 182     int                     sort_nalloc;     /* Allocation size of sort       */
 183
 184     nbnxn_sci_t            *sci_sort;        /* Second sci array, for sorting */
 185     int                     sci_sort_nalloc; /* Allocation size of sci_sort   */
 186
 187     gmx_cache_protect_t     cp1;             /* Protect cache between threads               */
 188 } nbnxn_list_work_t;
 189
 190 /* Function type for setting the i-atom coordinate working data */
 191 typedef void
 192     gmx_icell_set_x_t (int ci,
 193                        real shx, real shy, real shz,
 194                        int na_c,
 195                        int stride, const real *x,
 196                        nbnxn_list_work_t *work);
 197
 198 static gmx_icell_set_x_t icell_set_x_simple;
 199 #ifdef GMX_NBNXN_SIMD
 200 static gmx_icell_set_x_t icell_set_x_simple_simd_4xn;
 201 static gmx_icell_set_x_t icell_set_x_simple_simd_2xnn;
 202 #endif
 203 static gmx_icell_set_x_t icell_set_x_supersub;
 204 #ifdef NBNXN_SEARCH_SSE
 205 static gmx_icell_set_x_t icell_set_x_supersub_sse8;
 206 #endif
 207
 208 /* Local cycle count struct for profiling */
 209 typedef struct {
 210     int          count;
 211     gmx_cycles_t c;
 212     gmx_cycles_t start;
 213 } nbnxn_cycle_t;
 214
 215 /* Local cycle count enum for profiling */
 216 enum {
 217     enbsCCgrid, enbsCCsearch, enbsCCcombine, enbsCCreducef, enbsCCnr
 218 };
 219
 220 /* Thread-local work struct, contains part of nbnxn_grid_t */
 221 typedef struct {
 222     gmx_cache_protect_t  cp0;
 223
 224     int                 *cxy_na;
 225     int                  cxy_na_nalloc;
 226
 227     int                 *sort_work;
 228     int                  sort_work_nalloc;
 229
 230     nbnxn_buffer_flags_t buffer_flags; /* Flags for force buffer access */
 231
 232     int                  ndistc;       /* Number of distance checks for flop counting */
 233
 234     t_nblist            *nbl_fep;      /* Temporary FEP list for load balancing */
 235
 236     nbnxn_cycle_t        cc[enbsCCnr];
 237
 238     gmx_cache_protect_t  cp1;
 239 } nbnxn_search_work_t;
 240
 241 /* Main pair-search struct, contains the grid(s), not the pair-list(s) */
 242 typedef struct nbnxn_search {
 243     gmx_bool            bFEP;            /* Do we have perturbed atoms? */
 244     int                 ePBC;            /* PBC type enum                              */
 245     matrix              box;             /* The periodic unit-cell                     */
 246
 247     gmx_bool            DomDec;          /* Are we doing domain decomposition?         */
 248     ivec                dd_dim;          /* Are we doing DD in x,y,z?                  */
 249     gmx_domdec_zones_t *zones;           /* The domain decomposition zones        */
 250
 251     int                 ngrid;           /* The number of grids, equal to #DD-zones    */
 252     nbnxn_grid_t       *grid;            /* Array of grids, size ngrid                 */
 253     int                *cell;            /* Actual allocated cell array for all grids  */
 254     int                 cell_nalloc;     /* Allocation size of cell                    */
 255     int                *a;               /* Atom index for grid, the inverse of cell   */
 256     int                 a_nalloc;        /* Allocation size of a                       */
 257
 258     int                 natoms_local;    /* The local atoms run from 0 to natoms_local */
 259     int                 natoms_nonlocal; /* The non-local atoms run from natoms_local
 260                                           * to natoms_nonlocal */
 261
 262     gmx_bool             print_cycles;
 263     int                  search_count;
 264     nbnxn_cycle_t        cc[enbsCCnr];
 265
 266     gmx_icell_set_x_t   *icell_set_x; /* Function for setting i-coords    */
 267
 268     int                  nthread_max; /* Maximum number of threads for pair-search  */
 269     nbnxn_search_work_t *work;        /* Work array, size nthread_max          */
 270 } nbnxn_search_t_t;
 271
 272
 273 static void nbs_cycle_start(nbnxn_cycle_t *cc)
 274 {
 275     cc->start = gmx_cycles_read();
 276 }
 277
 278 static void nbs_cycle_stop(nbnxn_cycle_t *cc)
 279 {
 280     cc->c += gmx_cycles_read() - cc->start;
 281     cc->count++;
 282 }
 283
 284
 285 #ifdef __cplusplus
 286 }
 287 #endif
 288
 289 #endif