]> git.pond.sub.org Git - empserver/blobdiff - src/lib/empthread/io.c
Replace the per-iop input_timeout by per-function timeouts
[empserver] / src / lib / empthread / io.c
index 13d75ad710f501510b174490a1161ac4722ae402..f73d89d5dd28db6c8d18e55c1852349321e9829c 100644 (file)
@@ -1,11 +1,11 @@
 /*
  *  Empire - A multi-player, client/server Internet based war game.
- *  Copyright (C) 1986-2009, 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/>.
  *
  *  ---
  *
  *  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
  */
 
 /*
 #include <unistd.h>
 #include "empio.h"
 #include "empthread.h"
+#include "file.h"
 #include "ioqueue.h"
 #include "misc.h"
 #include "queue.h"
-#include "server.h"
 
 struct iop {
     int fd;
@@ -62,7 +62,7 @@ struct iop {
     struct ioqueue *output;
     int flags;
     int bufsize;
-    struct timeval input_timeout;
+    int last_out;
 };
 
 void
@@ -71,36 +71,51 @@ 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;
 
-    flags = flags & (IO_READ | IO_WRITE | IO_NBLOCK);
+    flags = flags & (IO_READ | IO_WRITE);
     if ((flags & (IO_READ | IO_WRITE)) == 0)
        return NULL;
+
+    fdfl = fcntl(fd, F_GETFL, 0);
+    if (fdfl < 0)
+       return NULL;
+    fdfl |= O_NONBLOCK;
+    if (fcntl(fd, F_SETFL, fdfl) < 0)
+       return NULL;
+
     iop = malloc(sizeof(struct iop));
     if (!iop)
        return NULL;
     iop->fd = fd;
     iop->input = NULL;
     iop->output = NULL;
-    iop->flags = 0;
-    iop->input_timeout = timeout;
+    iop->flags = flags;
+    iop->last_out = 0;
     iop->bufsize = bufsize;
     if (flags & IO_READ)
        iop->input = ioq_create(bufsize);
     if (flags & IO_WRITE)
        iop->output = ioq_create(bufsize);
-    if (flags & IO_NBLOCK)
-       io_noblocking(iop, 1);  /* FIXME check success */
-    iop->flags = flags;
     return iop;
 }
 
 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)
@@ -110,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;
@@ -143,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;
 }
@@ -175,69 +184,80 @@ io_outputwaiting(struct iop *iop)
     return ioq_qsize(iop->output);
 }
 
+/*
+ * Write output queued in IOP.
+ * If WAIT, writing may put the thread to sleep.
+ * Return number of bytes written on success, -1 on error.
+ * In particular, return zero when nothing was written because the
+ * queue was empty, or because the write slept and got woken up (only
+ * if WAIT), or because the write refused to sleep (only if !WAIT).
+ */
 int
-io_output(struct iop *iop, int waitforoutput)
+io_output(struct iop *iop, int wait)
 {
     struct iovec iov[16];
-    int cc;
-    int n;
-    int remain;
+    int n, res, cc;
 
-    /* If there is no output waiting. */
-    if (!io_outputwaiting(iop))
-       return 0;
+    if (wait)
+       ef_make_stale();
 
-    /* If the iop is not write enabled. */
     if ((iop->flags & IO_WRITE) == 0)
        return -1;
 
-    /* If the io is marked as in error... */
     if (iop->flags & IO_ERROR)
        return -1;
 
-    /* make the iov point to the data in the queue. */
-    /* I.E., each of the elements in the queue. */
-    /* returns the number of elements in the iov. */
-    n = ioq_makeiov(iop->output, iov, IO_BUFSIZE);
-
-    if (n <= 0) {
+    if (!ioq_qsize(iop->output))
        return 0;
-    }
 
-    /* wait for the file to be output ready. */
-    if (waitforoutput != IO_NOWAIT) {
-       /* This waits for the file to be ready for writing, */
-       /* and lets other threads run. */
-       empth_select(iop->fd, EMPTH_FD_WRITE, NULL);
+    if (wait) {
+       res = empth_select(iop->fd, EMPTH_FD_WRITE, NULL);
+       if (res == 0)
+           return 0;
+       if (res < 0) {
+           iop->flags |= IO_ERROR;
+           return -1;
+       }
     }
 
-    /* Do the actual write. */
+    n = ioq_makeiov(iop->output, iov, IO_BUFSIZE);
     cc = writev(iop->fd, iov, n);
-
-    /* if it failed.... */
     if (cc < 0) {
-       /* Hmm, it would block.  file is opened noblock, soooooo.. */
-       if (errno == EAGAIN || errno == EWOULDBLOCK) {
-           /* If there are remaining bytes, set the IO as remaining.. */
-           remain = ioq_qsize(iop->output);
-           return remain;
-       }
+       if (errno == EAGAIN || errno == EWOULDBLOCK)
+           return 0;
        iop->flags |= IO_ERROR;
        return -1;
     }
 
-    /* If no bytes were written, something happened..  Like an EOF. */
-    if (cc == 0) {
-       iop->flags |= IO_EOF;
-       return 0;
-    }
-
-    /* Remove the number of written bytes from the queue. */
     ioq_dequeue(iop->output, cc);
-
+    iop->last_out = ioq_qsize(iop->output);
     return cc;
 }
 
+/*
+ * Write output queued in IOP if enough have been enqueued.
+ * Write if at least one buffer has been filled since the last write.
+ * If WAIT, writing may put the thread to sleep.
+ * Return number of bytes written on success, -1 on error.
+ * In particular, return zero when nothing was written because the
+ * queue was not long, or the write slept and got woken up (only if
+ * WAIT), or the write refused to sleep (only if !WAIT).
+ */
+int
+io_output_if_queue_long(struct iop *iop, int wait)
+{
+    int len = ioq_qsize(iop->output);
+
+    if (CANT_HAPPEN(iop->last_out > len))
+       iop->last_out = 0;
+    if (len - iop->last_out < iop->bufsize) {
+       if (wait)
+           ef_make_stale();
+       return 0;
+    }
+    return io_output(iop, wait);
+}
+
 int
 io_peek(struct iop *iop, char *buf, int nbytes)
 {
@@ -260,41 +280,14 @@ io_read(struct iop *iop, char *buf, int nbytes)
 }
 
 int
-io_write(struct iop *iop, char *buf, int nbytes, int doWait)
+io_write(struct iop *iop, char *buf, int nbytes)
 {
-    int len;
-
     if ((iop->flags & IO_WRITE) == 0)
        return -1;
     ioq_append(iop->output, buf, nbytes);
-    len = ioq_qsize(iop->output);
-    if (len > iop->bufsize) {
-       if (doWait) {
-           io_output_all(iop);
-       } else {
-           /* only try a write every BUFSIZE characters */
-           if (((len - nbytes) % iop->bufsize) < (len % iop->bufsize))
-               io_output(iop, IO_NOWAIT);
-       }
-    }
     return nbytes;
 }
 
-int
-io_output_all(struct iop *iop)
-{
-    int n;
-
-    /*
-     * Mustn't block a player thread while update is pending, or else
-     * a malicous player could delay the update indefinitely
-     */
-    while ((n = io_output(iop, IO_NOWAIT)) > 0 && !play_wrlock_wanted)
-       empth_select(iop->fd, EMPTH_FD_WRITE, NULL);
-
-    return n;
-}
-
 int
 io_gets(struct iop *iop, char *buf, int nbytes)
 {
@@ -324,31 +317,11 @@ io_shutdown(struct iop *iop, int flags)
     if (flags & IO_WRITE) {
        shutdown(iop->fd, 1);
        ioq_drain(iop->output);
+       iop->last_out = 0;
     }
     return 0;
 }
 
-int
-io_noblocking(struct iop *iop, int value)
-{
-    int flags;
-
-    flags = fcntl(iop->fd, F_GETFL, 0);
-    if (flags < 0)
-       return -1;
-    if (value == 0)
-       flags &= ~O_NONBLOCK;
-    else
-       flags |= O_NONBLOCK;
-    if (fcntl(iop->fd, F_SETFL, flags) < 0)
-       return -1;
-    if (value == 0)
-       iop->flags &= ~IO_NBLOCK;
-    else
-       iop->flags |= IO_NBLOCK;
-    return 0;
-}
-
 int
 io_error(struct iop *iop)
 {
@@ -361,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)
 {