src/gromacs/imd/imdsocket.c

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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 /*! \internal \file
  37  *
  38  * \brief
  39  * Implements functions of imdsocket.h.
  40  *
  41  * This file re-implements vmdsock.c functions from original IMD API from scratch,
  42  * see imdsocket.h for references to the IMD API.
  43  *
  44  * \author Martin Hoefling, Carsten Kutzner <ckutzne@gwdg.de>
  45  *
  46  * \ingroup module_imd
  47  */
  48
  49 #ifdef HAVE_CONFIG_H
  50 #include <config.h>
  51 #endif
  52
  53 #include <errno.h>
  54 #include <string.h>
  55
  56 #include "gromacs/utility/smalloc.h"
  57 #include "gromacs/utility/fatalerror.h"
  58 #include "imdsocket.h"
  59 #include "imd.h"
  60
  61 #ifdef GMX_NATIVE_WINDOWS
  62 #ifdef GMX_HAVE_WINSOCK
  63 /*! \brief Define socklen type on Windows. */
  64 typedef int socklen_t;
  65
  66 /*! \brief Define a function to initialize winsock. */
  67 extern int imdsock_winsockinit()
  68 {
  69     int ret = -1;
  70
  71
  72     WSADATA wsd;
  73
  74     /* We use winsock 1.1 compatibility for now. Though I guess no one will try on Windows 95. */
  75     ret = WSAStartup(MAKEWORD(1, 1), &wsd);
  76     return ret;
  77 }
  78 #endif
  79 #else
  80 /* On UNIX, we can use nice errors from errno.h */
  81 #include <unistd.h>
  82 #endif
  83
  84
  85 /*! \brief Simple error handling. */
  86 #ifdef GMX_NATIVE_WINDOWS
  87 #define ERR_ARGS __FILE__, __LINE__, NULL
  88 #else
  89 #define ERR_ARGS __FILE__, __LINE__, strerror(errno)
  90 #endif
  91
  92
  93 /*! \brief Currently only 1 client connection is supported. */
  94 #define MAXIMDCONNECTIONS 1
  95
  96
  97 /*! \brief Print a nice error message on UNIX systems, using errno.h. */
  98 static void print_IMD_error(char *file, int line, char *msg)
  99 {
 100     fprintf(stderr, "%s Error in file %s on line %d.\n", IMDstr, file, line);
 101
 102     if (NULL != msg)
 103     {
 104         fprintf(stderr, "%s\n", msg);
 105     }
 106 }
 107
 108
 109 extern IMDSocket* imdsock_create()
 110 {
 111     IMDSocket *sock = NULL;
 112
 113
 114 #ifdef GMX_IMD
 115     snew(sock, 1);
 116     /* Try to create socket: */
 117     if ((sock->sockfd = socket(PF_INET, SOCK_STREAM, 0)) == -1)
 118     {
 119         print_IMD_error(ERR_ARGS);
 120         sfree(sock);
 121
 122         return NULL;
 123     }
 124     else
 125 #endif
 126     {
 127         return sock;
 128     }
 129 }
 130
 131
 132 extern int imdsock_bind(IMDSocket *sock, int port)
 133 {
 134     int ret = -1;
 135
 136
 137 #ifdef GMX_IMD
 138     memset(&(sock->address), 0, sizeof(sock->address));
 139     sock->address.sin_family = PF_INET;
 140     sock->address.sin_port   = htons(port);
 141
 142     /* Try to bind to address and port ...*/
 143     ret = bind(sock->sockfd, (struct sockaddr *) &sock->address, sizeof(sock->address));
 144 #endif
 145
 146     if (ret)
 147     {
 148         print_IMD_error(ERR_ARGS);
 149     }
 150
 151     return ret;
 152 }
 153
 154
 155 extern int imd_sock_listen(IMDSocket *sock)
 156 {
 157     int ret = -1;
 158
 159
 160 #ifdef GMX_IMD
 161     /* Try to set to listening state */
 162     ret = listen(sock->sockfd, MAXIMDCONNECTIONS);
 163 #endif
 164
 165     if (ret)
 166     {
 167         print_IMD_error(ERR_ARGS);
 168     }
 169
 170     return ret;
 171 }
 172
 173
 174 extern IMDSocket* imdsock_accept(IMDSocket *sock)
 175 {
 176     int       ret = -1;
 177
 178 #ifdef GMX_IMD
 179     socklen_t length;
 180
 181
 182     length = sizeof(sock->address);
 183     ret    = accept(sock->sockfd, (struct sockaddr *) &sock->address, &length);
 184
 185     /* successful, redirect to distinct clientsocket */
 186     if (ret >= 0)
 187     {
 188         IMDSocket *newsock;
 189
 190         snew(newsock, 1);
 191         newsock->address    = sock->address;
 192         newsock->sockfd     = ret;
 193
 194         return newsock;
 195     }
 196     else
 197 #endif
 198     {
 199         print_IMD_error(ERR_ARGS);
 200
 201         return NULL;
 202     }
 203 }
 204
 205
 206 extern int imdsock_getport(IMDSocket *sock, int *port)
 207 {
 208     int                ret = -1;
 209 #ifdef GMX_IMD
 210     struct sockaddr_in sin;
 211     socklen_t          len;
 212
 213
 214     len = sizeof(sin);
 215     ret = getsockname(sock->sockfd, (struct sockaddr *) &(sock->address), &len);
 216     if (ret)
 217     {
 218         fprintf(stderr, "%s getsockname failed with error %d.\n", IMDstr, ret);
 219         print_IMD_error(ERR_ARGS);
 220     }
 221     else
 222     {
 223         *port = ntohs(sock->address.sin_port);
 224     }
 225 #else
 226     gmx_incons("imdsock_getport called without IMD support.");
 227 #endif
 228
 229     return ret;
 230 }
 231
 232
 233 extern int imdsock_write(IMDSocket *sock, const char *buffer, int length)
 234 {
 235     /* No read and write on windows, we have to use send and recv instead... */
 236 #ifdef GMX_NATIVE_WINDOWS
 237 #ifdef GMX_HAVE_WINSOCK
 238     return send(sock->sockfd, (const char *) buffer, length, NOFLAGS);
 239 #else
 240     return -1;
 241 #endif
 242 #else
 243     return write(sock->sockfd, buffer, length);
 244 #endif
 245 }
 246
 247
 248 extern int imdsock_read(IMDSocket *sock, char *buffer, int length)
 249 {
 250     /* See above... */
 251 #ifdef GMX_NATIVE_WINDOWS
 252 #ifdef GMX_HAVE_WINSOCK
 253     return recv(sock->sockfd, (char *) buffer, length, NOFLAGS);
 254 #else
 255     return -1;
 256 #endif
 257 #else
 258     return read(sock->sockfd, buffer, length);
 259 #endif
 260 }
 261
 262
 263 extern void imdsock_shutdown(IMDSocket *sock)
 264 {
 265     int ret = -1;
 266
 267
 268     /* is the socket already NULL? */
 269     if (sock == NULL)
 270     {
 271         return;
 272     }
 273
 274 #ifdef GMX_IMD
 275     /* If not, try to properly shut down. */
 276     ret = shutdown(sock->sockfd, 1);
 277 #endif
 278
 279     if (ret == -1)
 280     {
 281         fprintf(stderr, "%s Failed to shutdown socket. Did the client already disconnect?\n", IMDstr);
 282         print_IMD_error(ERR_ARGS);
 283     }
 284 }
 285
 286
 287 extern int imdsock_destroy(IMDSocket *sock)
 288 {
 289     int ret = -1;
 290
 291
 292     if (sock == NULL)
 293     {
 294         return 1;
 295     }
 296
 297 #ifdef GMX_NATIVE_WINDOWS
 298     /* On Windows, this function is called closesocket */
 299 #ifdef GMX_HAVE_WINSOCK
 300     ret = closesocket(sock->sockfd);
 301 #endif
 302 #else
 303     ret = close(sock->sockfd);
 304 #endif
 305
 306     if (ret == -1)
 307     {
 308         sfree(sock);
 309         print_IMD_error(ERR_ARGS);
 310
 311         return 0;
 312     }
 313
 314     return 1;
 315 }
 316
 317
 318 extern int imdsock_tryread(IMDSocket *sock, int timeoutsec, int timeoutusec)
 319 {
 320     int             ret = -1;
 321
 322
 323 #ifdef GMX_IMD
 324     fd_set          readfds;
 325     /* Create new time structure with sec and usec. */
 326     struct timeval *tval;
 327
 328
 329     snew(tval, 1);
 330
 331     /* clear the set */
 332     FD_ZERO(&readfds);
 333     /* add the socket to the read set */
 334     FD_SET(sock->sockfd, &readfds);
 335
 336     /* set the timeout */
 337     tval->tv_sec  = timeoutsec;
 338     tval->tv_usec = timeoutusec;
 339     do
 340     {
 341         /* check the set for read readiness. */
 342         ret = select(sock->sockfd + 1, &readfds, NULL, NULL, tval);
 343         /* redo on system interrupt */
 344     }
 345     while (ret < 0 && errno == EINTR);
 346
 347     sfree(tval);
 348 #endif
 349
 350     if (ret < 0)
 351     {
 352         print_IMD_error(ERR_ARGS);
 353     }
 354
 355     return ret;
 356 }