src/gromacs/gmxlib/network.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team.
   6  * Copyright (c) 2013,2014,2015,2016,2017,2018,2019, by the GROMACS development team, led by
   7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   8  * and including many others, as listed in the AUTHORS file in the
   9  * top-level source directory and at http://www.gromacs.org.
  10  *
  11  * GROMACS is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public License
  13  * as published by the Free Software Foundation; either version 2.1
  14  * of the License, or (at your option) any later version.
  15  *
  16  * GROMACS is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with GROMACS; if not, see
  23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  *
  26  * If you want to redistribute modifications to GROMACS, please
  27  * consider that scientific software is very special. Version
  28  * control is crucial - bugs must be traceable. We will be happy to
  29  * consider code for inclusion in the official distribution, but
  30  * derived work must not be called official GROMACS. Details are found
  31  * in the README & COPYING files - if they are missing, get the
  32  * official version at http://www.gromacs.org.
  33  *
  34  * To help us fund GROMACS development, we humbly ask that you cite
  35  * the research papers on the package. Check out http://www.gromacs.org.
  36  */
  37 #ifndef GMX_GMXLIB_NETWORK_H
  38 #define GMX_GMXLIB_NETWORK_H
  39
  40 /*
  41  * This module defines the interface of the actual communication routines.
  42  */
  43
  44 #include <stdio.h>
  45
  46 #include "gromacs/utility/basedefinitions.h"
  47 #include "gromacs/utility/gmxmpi.h"
  48 #include "gromacs/utility/stringutil.h"
  49 #include "gromacs/utility/unique_cptr.h"
  50
  51 struct gmx_multisim_t;
  52 struct t_commrec;
  53 struct t_filenm;
  54
  55 //! Free memory associated with the commrec.
  56 void done_commrec(t_commrec* cr);
  57
  58 //! Convenience alias.
  59 using CommrecHandle = gmx::unique_cptr<t_commrec, done_commrec>;
  60
  61 //! Allocate, initialize and return the commrec.
  62 CommrecHandle init_commrec(MPI_Comm communicator, const gmx_multisim_t* ms);
  63
  64 struct t_commrec* reinitialize_commrec_for_this_thread(const t_commrec* cro);
  65
  66 /* Initialize communication records for thread-parallel simulations.
  67    Must be called on all threads before any communication takes place by
  68    the individual threads. Copies the original commrec to
  69    thread-local versions (a small memory leak results because we don't
  70    deallocate the old shared version).  */
  71
  72 void gmx_fill_commrec_from_mpi(t_commrec* cr);
  73 /* Continues t_commrec construction */
  74
  75 void gmx_setup_nodecomm(FILE* fplog, struct t_commrec* cr);
  76 /* Sets up fast global communication for clusters with multi-core nodes */
  77
  78 void gmx_barrier(const struct t_commrec* cr);
  79 /* Wait till all processes in cr->mpi_comm_mygroup have reached the barrier */
  80
  81 void gmx_bcast(int nbytes, void* b, const struct t_commrec* cr);
  82 /* Broadcast nbytes bytes from the master to cr->mpi_comm_mygroup */
  83
  84 void gmx_bcast_sim(int nbytes, void* b, const struct t_commrec* cr);
  85 /* Broadcast nbytes bytes from the sim master to cr->mpi_comm_mysim */
  86
  87 void gmx_sumi(int nr, int r[], const struct t_commrec* cr);
  88 /* Calculate the global sum of an array of ints */
  89
  90 void gmx_sumli(int nr, int64_t r[], const struct t_commrec* cr);
  91 /* Calculate the global sum of an array of large ints */
  92
  93 void gmx_sumf(int nr, float r[], const struct t_commrec* cr);
  94 /* Calculate the global sum of an array of floats */
  95
  96 void gmx_sumd(int nr, double r[], const struct t_commrec* cr);
  97 /* Calculate the global sum of an array of doubles */
  98
  99 #if GMX_DOUBLE
 100 #    define gmx_sum gmx_sumd
 101 #else
 102 #    define gmx_sum gmx_sumf
 103 #endif
 104
 105 const char* opt2fn_master(const char* opt, int nfile, const t_filenm fnm[], t_commrec* cr);
 106 /* Return the filename belonging to cmd-line option opt, or NULL when
 107  * no such option or not running on master */
 108
 109 [[noreturn]] void gmx_fatal_collective(int                    f_errno,
 110                                        const char*            file,
 111                                        int                    line,
 112                                        MPI_Comm               comm,
 113                                        gmx_bool               bMaster,
 114                                        gmx_fmtstr const char* fmt,
 115                                        ...) gmx_format(printf, 6, 7);
 116 /* As gmx_fatal declared in utility/fatalerror.h,
 117  * but only the master process prints the error message.
 118  * This should only be called one of the following two situations:
 119  * 1) On all nodes in cr->mpi_comm_mysim, with cr!=NULL,dd==NULL.
 120  * 2) On all nodes in dd->mpi_comm_all,   with cr==NULL,dd!=NULL.
 121  * This will call MPI_Finalize instead of MPI_Abort when possible,
 122  * This is useful for handling errors in code that is executed identically
 123  * for all processes.
 124  */
 125
 126 //! Make a barrier across all ranks of this simulation
 127 void simulationBarrier(const t_commrec* cr);
 128
 129 #endif