src/gromacs/imd/imdsocket.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2014,2015,2016, 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 /*! \libinternal \file
  37  *
  38  * \brief
  39  * Implements the parts of the vmdsock.h interface needed for IMD communication.
  40  *
  41  * \author Martin Hoefling, Carsten Kutzner <ckutzne@gwdg.de>
  42  *
  43  * For more information, see https://www-s.ks.uiuc.edu/Research/vmd/imd/ for general
  44  * IMD information and https://www-s.ks.uiuc.edu/Research/vmd/imd/code/imdapi.tar.gz
  45  * for the IMD reference implementation and API.
  46  *
  47  * \inlibraryapi
  48  * \ingroup module_imd
  49  */
  50
  51 #ifndef GMX_IMD_IMDSOCKET_H
  52 #define GMX_IMD_IMDSOCKET_H
  53
  54 #include "config.h"
  55
  56 /* Check if we can/should use winsock or standard UNIX sockets. */
  57 #if GMX_NATIVE_WINDOWS
  58   #ifdef GMX_HAVE_WINSOCK
  59   #include <Winsock.h>
  60   #define GMX_IMD
  61   #endif
  62 #else
  63 #include <netinet/in.h>
  64 #include <sys/socket.h>
  65 #define GMX_IMD
  66 #endif
  67
  68 /*! \internal
  69  *
  70  * \brief
  71  * IMD (interactive molecular dynamics) socket structure
  72  *
  73  */
  74 typedef struct
  75 {
  76 #ifdef GMX_IMD
  77     struct sockaddr_in address;      /**< address of socket                   */
  78 #endif
  79     int                sockfd;       /**< socket file descriptor              */
  80 } IMDSocket;
  81
  82
  83
  84 #if GMX_NATIVE_WINDOWS && defined(GMX_HAVE_WINSOCK)
  85 /*! \internal
  86  *
  87  * \brief Function to initialize winsock
  88  *
  89  * \returns 0 if successful.
  90  */
  91 int imdsock_winsockinit();
  92 #endif
  93
  94
  95 /*! \brief Create an IMD master socket.
  96  *
  97  * \returns  The IMD socket if successful. Otherwise prints an error message and returns NULL.
  98  */
  99 IMDSocket *imdsock_create();
 100
 101
 102 /*! \brief Bind the IMD socket to address and port.
 103  *
 104  * Prints out an error message if unsuccessful.
 105  * If port == 0, bind() assigns a free port automatically.
 106  *
 107  *
 108  * \param sock      The IMD socket.
 109  * \param port      The port to bind to.
 110  *
 111  * \returns 0 if successful.
 112  */
 113 int imdsock_bind(IMDSocket *sock, int port);
 114
 115
 116 /*! \brief Set socket to listening state.
 117  *
 118  * Prints out an error message if unsuccessful.
 119  *
 120  * \param sock      The IMD socket.
 121  *
 122  * \returns 0 if successful.
 123  *
 124  */
 125 int imd_sock_listen(IMDSocket *sock);
 126
 127
 128 /*! \brief Accept incoming connection and redirect to client socket.
 129  *
 130  * Prints out an error message if unsuccessful.
 131  *
 132  * \param sock      The IMD socket.
 133  *
 134  * \returns IMD socket if successful, NULL otherwise.
 135  */
 136 IMDSocket *imdsock_accept(IMDSocket *sock);
 137
 138
 139 /*! \brief Get the port number used for IMD connection.
 140  *
 141  * Prints out an error message if unsuccessful.
 142  *
 143  * \param sock      The IMD socket.
 144  * \param port      The assigned port number.
 145  *
 146  * \returns 0 if successful, an error code otherwise.
 147  */
 148 int imdsock_getport(IMDSocket *sock, int *port);
 149
 150
 151 /*! \brief  Write to socket.
 152  *
 153  *
 154  * \param sock      The IMD socket.
 155  * \param buffer    The data to write.
 156  * \param length    Number of bytes to write.
 157  *
 158  * \returns The number of bytes written, or -1.
 159  */
 160 int imdsock_write(IMDSocket *sock, const char *buffer, int length);
 161
 162
 163 /*! \brief  Read from socket.
 164  *
 165  * \param sock      The IMD socket.
 166  * \param buffer    Buffer to put the read data.
 167  * \param length    Number of bytes to read.
 168  *
 169  * \returns The number of bytes read, or -1 for errors.
 170  */
 171 int imdsock_read(IMDSocket *sock, char *buffer, int length);
 172
 173
 174 /*! \brief Shutdown the socket.
 175  *
 176  * \param sock      The IMD socket.
 177  *
 178  */
 179 void imdsock_shutdown(IMDSocket *sock);
 180
 181
 182 /*! \brief Close the socket and free the sock struct memory.
 183  *
 184  * Writes an error message if unsuccessful.
 185  *
 186  * \param sock      The IMD socket.
 187  *
 188  * \returns 1 on success, or 0 if unsuccessful.
 189  */
 190 int imdsock_destroy(IMDSocket *sock);
 191
 192
 193 /*! \brief Try to read from the socket.
 194  *
 195  * Time out after waiting the interval specified.
 196  * Print an error message if unsuccessful.
 197  *
 198  * \param sock         The IMD socket.
 199  * \param timeoutsec   Time out seconds
 200  * \param timeoutusec  Time out microseconds
 201  *
 202  */
 203 int imdsock_tryread(IMDSocket *sock, int timeoutsec, int timeoutusec);
 204
 205 #endif