2 * This file is part of the GROMACS molecular simulation package.
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.
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.
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.
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.
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.
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.
39 * Implements functions of imdsocket.h.
41 * This file re-implements vmdsock.c functions from original IMD API from scratch,
42 * see imdsocket.h for references to the IMD API.
44 * \author Martin Hoefling, Carsten Kutzner <ckutzne@gwdg.de>
51 #include "imdsocket.h"
58 #include "gromacs/imd/imd.h"
59 #include "gromacs/utility/fatalerror.h"
60 #include "gromacs/utility/smalloc.h"
62 #if GMX_NATIVE_WINDOWS
63 #ifdef GMX_HAVE_WINSOCK
64 /*! \brief Define socklen type on Windows. */
65 typedef int socklen_t;
67 /*! \brief Define a function to initialize winsock. */
68 extern int imdsock_winsockinit()
75 /* We use winsock 1.1 compatibility for now. Though I guess no one will try on Windows 95. */
76 ret = WSAStartup(MAKEWORD(1, 1), &wsd);
81 /* On UNIX, we can use nice errors from errno.h */
86 #include <sys/select.h>
92 /*! \brief Simple error handling. */
93 #if GMX_NATIVE_WINDOWS
94 #define ERR_ARGS __FILE__, __LINE__, NULL
96 #define ERR_ARGS __FILE__, __LINE__, strerror(errno)
100 /*! \brief Currently only 1 client connection is supported. */
101 #define MAXIMDCONNECTIONS 1
104 /*! \brief Print a nice error message on UNIX systems, using errno.h. */
105 static void print_IMD_error(const char *file, int line, char *msg)
107 fprintf(stderr, "%s Error in file %s on line %d.\n", IMDstr, file, line);
111 fprintf(stderr, "%s\n", msg);
115 /*! \brief Byte swap in case we are little-endian */
116 static uint16_t gmx_htons(uint16_t src)
120 if (*(char *)&num == 1)
128 dest |= (src & 0x0000FF00) >> 8;
129 dest |= (src & 0x000000FF) << 8;
135 /*! \brief Byte-unswap 16 bit word in case we are little-endian */
136 static uint16_t gmx_ntohs(uint16_t src)
138 return gmx_htons(src);
142 extern IMDSocket* imdsock_create()
144 IMDSocket *sock = NULL;
149 /* Try to create socket: */
150 if ((sock->sockfd = socket(PF_INET, SOCK_STREAM, 0)) == -1)
152 print_IMD_error(ERR_ARGS);
165 extern int imdsock_bind(IMDSocket *sock, int port)
171 memset(&(sock->address), 0, sizeof(sock->address));
172 sock->address.sin_family = PF_INET;
173 sock->address.sin_port = gmx_htons(port);
175 /* Try to bind to address and port ...*/
176 ret = bind(sock->sockfd, (struct sockaddr *) &sock->address, sizeof(sock->address));
183 print_IMD_error(ERR_ARGS);
190 extern int imd_sock_listen(IMDSocket *sock)
196 /* Try to set to listening state */
197 ret = listen(sock->sockfd, MAXIMDCONNECTIONS);
204 print_IMD_error(ERR_ARGS);
211 extern IMDSocket* imdsock_accept(IMDSocket *sock)
219 length = sizeof(sock->address);
220 ret = accept(sock->sockfd, (struct sockaddr *) &sock->address, &length);
222 /* successful, redirect to distinct clientsocket */
228 newsock->address = sock->address;
229 newsock->sockfd = ret;
236 print_IMD_error(ERR_ARGS);
243 extern int imdsock_getport(IMDSocket *sock, int *port)
250 len = sizeof(struct sockaddr_in);
251 ret = getsockname(sock->sockfd, (struct sockaddr *) &(sock->address), &len);
254 fprintf(stderr, "%s getsockname failed with error %d.\n", IMDstr, ret);
255 print_IMD_error(ERR_ARGS);
259 *port = gmx_ntohs(sock->address.sin_port);
262 gmx_incons("imdsock_getport called without IMD support.");
270 extern int imdsock_write(IMDSocket *sock, const char *buffer, int length)
272 /* No read and write on windows, we have to use send and recv instead... */
273 #if GMX_NATIVE_WINDOWS
274 #ifdef GMX_HAVE_WINSOCK
275 return send(sock->sockfd, (const char *) buffer, length, NOFLAGS);
280 return write(sock->sockfd, buffer, length);
285 extern int imdsock_read(IMDSocket *sock, char *buffer, int length)
288 #if GMX_NATIVE_WINDOWS
289 #ifdef GMX_HAVE_WINSOCK
290 return recv(sock->sockfd, (char *) buffer, length, NOFLAGS);
295 return read(sock->sockfd, buffer, length);
300 extern void imdsock_shutdown(IMDSocket *sock)
305 /* is the socket already NULL? */
312 /* If not, try to properly shut down. */
313 ret = shutdown(sock->sockfd, 1);
318 fprintf(stderr, "%s Failed to shutdown socket. Did the client already disconnect?\n", IMDstr);
319 print_IMD_error(ERR_ARGS);
324 extern int imdsock_destroy(IMDSocket *sock)
334 #if GMX_NATIVE_WINDOWS
335 /* On Windows, this function is called closesocket */
336 #ifdef GMX_HAVE_WINSOCK
337 ret = closesocket(sock->sockfd);
340 ret = close(sock->sockfd);
346 print_IMD_error(ERR_ARGS);
355 extern int imdsock_tryread(IMDSocket *sock, int timeoutsec, int timeoutusec)
362 /* Create new time structure with sec and usec. */
363 struct timeval *tval;
370 /* add the socket to the read set */
371 FD_SET(sock->sockfd, &readfds);
373 /* set the timeout */
374 tval->tv_sec = timeoutsec;
375 tval->tv_usec = timeoutusec;
378 /* check the set for read readiness. */
379 ret = select(sock->sockfd + 1, &readfds, NULL, NULL, tval);
380 /* redo on system interrupt */
382 while (ret < 0 && errno == EINTR);
389 print_IMD_error(ERR_ARGS);