Replace the per-iop input_timeout by per-function timeouts

[empserver] / src / lib / empthread / io.c

diff --git a/src/lib/empthread/io.c b/src/lib/empthread/io.c
index 1d78504deef7913b6b3066283548bcd311f25da3..f73d89d5dd28db6c8d18e55c1852349321e9829c 100644 (file)
--- a/src/lib/empthread/io.c
+++ b/src/lib/empthread/io.c
@@ -1,11 +1,11 @@
 /*
  *  Empire - A multi-player, client/server Internet based war game.
- *  Copyright (C) 1986-2010, Dave Pare, Jeff Bailey, Thomas Ruschak,
- *                           Ken Stevens, Steve McClure
+ *  Copyright (C) 1986-2011, Dave Pare, Jeff Bailey, Thomas Ruschak,
+ *                Ken Stevens, Steve McClure, Markus Armbruster
  *
- *  This program is free software; you can redistribute it and/or modify
+ *  Empire is free software: you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
- *  the Free Software Foundation; either version 2 of the License, or
+ *  the Free Software Foundation, either version 3 of the License, or
  *  (at your option) any later version.
  *
  *  This program is distributed in the hope that it will be useful,
@@ -14,8 +14,7 @@
  *  GNU General Public License for more details.
  *
  *  You should have received a copy of the GNU General Public License
- *  along with this program; if not, write to the Free Software
- *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  *
  *  ---
  *
@@ -28,9 +27,10 @@
  *  io.c: Arrange for input and output on a file descriptor to be queued.
  *
  *  Known contributors to this file:
- *      Doug Hay, 1998
- *      Steve McClure, 1998
- *      Ron Koenderink, 2009
+ *     Doug Hay, 1998
+ *     Steve McClure, 1998
+ *     Markus Armbruster, 2004-2012
+ *     Ron Koenderink, 2009
  */
 
 /*
@@ -63,7 +63,6 @@ struct iop {
     int flags;
     int bufsize;
     int last_out;
-    struct timeval input_timeout;
 };
 
 void
@@ -72,7 +71,7 @@ io_init(void)
 }
 
 struct iop *
-io_open(int fd, int flags, int bufsize, struct timeval timeout)
+io_open(int fd, int flags, int bufsize)
 {
     int fdfl;
     struct iop *iop;
@@ -97,7 +96,6 @@ io_open(int fd, int flags, int bufsize, struct timeval timeout)
     iop->flags = flags;
     iop->last_out = 0;
     iop->bufsize = bufsize;
-    iop->input_timeout = timeout;
     if (flags & IO_READ)
        iop->input = ioq_create(bufsize);
     if (flags & IO_WRITE)
@@ -106,9 +104,18 @@ io_open(int fd, int flags, int bufsize, struct timeval timeout)
 }
 
 void
-io_close(struct iop *iop)
+io_close(struct iop *iop, struct timeval *timeout)
 {
-
+    char buf[IO_BUFSIZE];
+    int ret;
+
+    while (io_output(iop, 1) > 0) ;
+    shutdown(iop->fd, SHUT_WR);
+    while (empth_select(iop->fd, EMPTH_FD_READ, timeout) > 0) {
+       ret = read(iop->fd, buf, sizeof(buf));
+       if (ret <= 0)
+           break;
+    }
     if (iop->input)
        ioq_destroy(iop->input);
     if (iop->output)
@@ -118,32 +125,30 @@ io_close(struct iop *iop)
 }
 
 /*
- * Return number of bytes read on success, zero on timeout, early
- * wakeup or EOF, -1 on error, with errno set appropriately.  In
- * particular, return -1 with errno set to EAGAIN or EWOULDBLOCK when
- * no data is available for non-blocking input (WAITFORINPUT false).
- * Use io_eof() to distinguish timeout and early wakeup from EOF.
+ * Read input from IOP and enqueue it.
+ * If TIMEOUT is non-null, wait at most that long for input to arrive.
+ * Does not yield the processor when timeout is zero.
+ * A wait for input can be cut short by empth_wakeup().
+ * Return number of bytes read on success, -1 on error.
+ * In particular, return zero on timeout, early wakeup or EOF.  Use
+ * io_eof() to distinguish timeout and early wakeup from EOF.
  */
 int
-io_input(struct iop *iop, int waitforinput)
+io_input(struct iop *iop, struct timeval *timeout)
 {
     char buf[IO_BUFSIZE];
     int cc;
     int res;
 
-    /* Not a read IOP */
-    if ((iop->flags & IO_READ) == 0) {
-       errno = EBADF;
+    if ((iop->flags & IO_READ) == 0)
        return -1;
-    }
-    /* IOP is markes as in error. */
-    if (iop->flags & IO_ERROR) {
-       errno = EBADF;
+    if (iop->flags & IO_ERROR)
        return -1;
-    }
-    /* Wait for the file to have input. */
-    if (waitforinput) {
-       res = empth_select(iop->fd, EMPTH_FD_READ, &iop->input_timeout);
+    if (iop->flags & IO_EOF)
+       return 0;
+
+    if (!timeout || timeout->tv_sec || timeout->tv_usec) {
+       res = empth_select(iop->fd, EMPTH_FD_READ, timeout);
        if (res < 0) {
            iop->flags |= IO_ERROR;
            return -1;
@@ -151,22 +156,18 @@ io_input(struct iop *iop, int waitforinput)
            return 0;
     }
 
-    /* Do the actual read. */
     cc = read(iop->fd, buf, sizeof(buf));
     if (cc < 0) {
-       if (errno != EAGAIN && errno != EWOULDBLOCK)
-           /* Some form of file error occurred... */
-           iop->flags |= IO_ERROR;
+       if (errno == EAGAIN || errno == EWOULDBLOCK)
+           return 0;
+       iop->flags |= IO_ERROR;
        return -1;
     }
-
-    /* We eof'd */
     if (cc == 0) {
        iop->flags |= IO_EOF;
        return 0;
     }
 
-    /* Append the input to the IOQ. */
     ioq_append(iop->input, buf, cc);
     return cc;
 }
@@ -200,15 +201,15 @@ io_output(struct iop *iop, int wait)
     if (wait)
        ef_make_stale();
 
-    if (!ioq_qsize(iop->output))
-       return 0;
-
     if ((iop->flags & IO_WRITE) == 0)
        return -1;
 
     if (iop->flags & IO_ERROR)
        return -1;
 
+    if (!ioq_qsize(iop->output))
+       return 0;
+
     if (wait) {
        res = empth_select(iop->fd, EMPTH_FD_WRITE, NULL);
        if (res == 0)
@@ -257,7 +258,6 @@ io_output_if_queue_long(struct iop *iop, int wait)
     return io_output(iop, wait);
 }
 
-
 int
 io_peek(struct iop *iop, char *buf, int nbytes)
 {
@@ -334,6 +334,17 @@ io_eof(struct iop *iop)
     return iop->flags & IO_EOF;
 }
 
+/*
+ * Discard IOP's buffered input and set its EOF flag.
+ * No more input can be read from IOP.
+ */
+void
+io_set_eof(struct iop *iop)
+{
+    ioq_drain(iop->input);
+    iop->flags |= IO_EOF;
+}
+
 int
 io_fileno(struct iop *iop)
 {