2 * This file is part of the GROMACS molecular simulation package.
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.
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.
36 /*! \libinternal \file
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>
57 #include "gmx_fatal.h"
58 #include "imdsocket.h"
62 #ifdef 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 */
87 /*! \brief Simple error handling. */
88 #ifdef GMX_NATIVE_WINDOWS
89 #define ERR_ARGS __FILE__, __LINE__, NULL
91 #define ERR_ARGS __FILE__, __LINE__, strerror(errno)
95 /*! \brief Currently only 1 client connection is supported. */
96 #define MAXIMDCONNECTIONS 1
99 /*! \brief Print a nice error message on UNIX systems, using errno.h. */
100 static void print_IMD_error(char *file, int line, char *msg)
102 fprintf(stderr, "%s Error in file %s on line %d.\n", IMDstr, file, line);
106 fprintf(stderr, "%s\n", msg);
111 extern IMDSocket* imdsock_create()
113 IMDSocket *sock = NULL;
118 /* Try to create socket: */
119 if ((sock->sockfd = socket(PF_INET, SOCK_STREAM, 0)) == -1)
121 print_IMD_error(ERR_ARGS);
134 extern int imdsock_bind(IMDSocket *sock, int port)
140 memset(&(sock->address), 0, sizeof(sock->address));
141 sock->address.sin_family = PF_INET;
142 sock->address.sin_port = htons(port);
144 /* Try to bind to address and port ...*/
145 ret = bind(sock->sockfd, (struct sockaddr *) &sock->address, sizeof(sock->address));
150 print_IMD_error(ERR_ARGS);
157 extern int imd_sock_listen(IMDSocket *sock)
163 /* Try to set to listening state */
164 ret = listen(sock->sockfd, MAXIMDCONNECTIONS);
169 print_IMD_error(ERR_ARGS);
176 extern IMDSocket* imdsock_accept(IMDSocket *sock)
184 length = sizeof(sock->address);
185 ret = accept(sock->sockfd, (struct sockaddr *) &sock->address, &length);
187 /* successful, redirect to distinct clientsocket */
193 newsock->address = sock->address;
194 newsock->sockfd = ret;
201 print_IMD_error(ERR_ARGS);
208 extern int imdsock_getport(IMDSocket *sock, int *port)
212 struct sockaddr_in sin;
217 ret = getsockname(sock->sockfd, (struct sockaddr *) &(sock->address), &len);
220 fprintf(stderr, "%s getsockname failed with error %d.\n", IMDstr, ret);
221 print_IMD_error(ERR_ARGS);
225 *port = ntohs(sock->address.sin_port);
228 gmx_incons("imdsock_getport called without IMD support.");
235 extern int imdsock_write(IMDSocket *sock, const char *buffer, int length)
237 /* No read and write on windows, we have to use send and recv instead... */
238 #ifdef GMX_NATIVE_WINDOWS
239 #ifdef GMX_HAVE_WINSOCK
240 return send(sock->sockfd, (const char *) buffer, length, NOFLAGS);
245 return write(sock->sockfd, buffer, length);
250 extern int imdsock_read(IMDSocket *sock, char *buffer, int length)
253 #ifdef GMX_NATIVE_WINDOWS
254 #ifdef GMX_HAVE_WINSOCK
255 return recv(sock->sockfd, (char *) buffer, length, NOFLAGS);
260 return read(sock->sockfd, buffer, length);
265 extern void imdsock_shutdown(IMDSocket *sock)
270 /* is the socket already NULL? */
277 /* If not, try to properly shut down. */
278 ret = shutdown(sock->sockfd, 1);
283 fprintf(stderr, "%s Failed to shutdown socket. Did the client already disconnect?\n", IMDstr);
284 print_IMD_error(ERR_ARGS);
289 extern int imdsock_destroy(IMDSocket *sock)
299 #ifdef GMX_NATIVE_WINDOWS
300 /* On Windows, this function is called closesocket */
301 #ifdef GMX_HAVE_WINSOCK
302 ret = closesocket(sock->sockfd);
305 ret = close(sock->sockfd);
311 print_IMD_error(ERR_ARGS);
320 extern int imdsock_tryread(IMDSocket *sock, int timeoutsec, int timeoutusec)
327 /* Create new time structure with sec and usec. */
328 struct timeval *tval;
335 /* add the socket to the read set */
336 FD_SET(sock->sockfd, &readfds);
338 /* set the timeout */
339 tval->tv_sec = timeoutsec;
340 tval->tv_usec = timeoutusec;
343 /* check the set for read readiness. */
344 ret = select(sock->sockfd + 1, &readfds, NULL, NULL, tval);
345 /* redo on system interrupt */
347 while (ret < 0 && errno == EINTR);
354 print_IMD_error(ERR_ARGS);