2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
5 * Copyright (c) 2001-2004, The GROMACS development team.
6 * Copyright (c) 2013,2014, 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.
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.
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.
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.
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.
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.
37 /*! \libinternal \file
39 * Utility functions for basic MPI and network functionality.
42 * \ingroup module_utility
44 #ifndef GMX_UTILITY_BASENETWORK_H
45 #define GMX_UTILITY_BASENETWORK_H
49 #include "gromacs/utility/basedefinitions.h"
56 * Sets the hostname to the value given by gethostname(), if available.
58 * \param[out] name Buffer to receive the hostname.
59 * \param[in] len Length of buffer \p name (must be >= 8).
60 * \returns 0 on success, -1 on error.
62 * If the value is not available, "unknown" is returned.
63 * \p name should have at least size \p len.
65 int gmx_gethostname(char *name, size_t len);
68 * Returns whether MPI has been initialized.
70 * The return value is `FALSE` if MPI_Init() has not been called, or if
71 * \Gromacs has been compiled without MPI support.
72 * For thread-MPI, returns `TRUE` when the threads have been started.
74 * Note that there is a lot of code in between MPI_Init() and the thread-MPI
75 * thread start where the return value is different depending on compilation
78 gmx_bool gmx_mpi_initialized(void);
81 * Returns the number of nodes.
83 * For thread-MPI, returns one before the threads have been started.
84 * This allows code between the real MPI_Init() and the thread-MPI "init" to
85 * still use this function to check for serial/parallel status and work as
86 * expected: for thread-MPI, at that point they should behave as if the run was
89 int gmx_node_num(void);
92 * Returns the rank of the node.
94 * For thread-MPI, returns zero before the threads have been started.
95 * This allows code between the real MPI_Init() and the thread-MPI "init" to
96 * still use this function to check for master node work as expected:
97 * for thread-MPI, at that point the only thread of execution should behave as
98 * if it the master node.
100 int gmx_node_rank(void);
103 * Return a non-negative hash that is, hopefully, unique for each physical
106 * This hash is useful for determining hardware locality.
108 int gmx_physicalnode_id_hash(void);
111 * Returns an integer characteristic of and, hopefully, unique to each
112 * physical node in the MPI system.
114 * If the first part of the MPI hostname (up to the first dot) ends with a
115 * number, returns this number. If the first part of the MPI hostname does not
116 * ends in a number (0-9 characters), returns 0.
119 * This function should be fully replaced by gmx_physicalnode_id_hash().
121 int gmx_hostname_num(void);
123 /** Abort the parallel run */
124 void gmx_abort(int errorno);