]> git.pond.sub.org Git - empserver/blobdiff - src/lib/gen/ioqueue.c
Update copyright notice
[empserver] / src / lib / gen / ioqueue.c
index 123607a5315c9770ca39908630c426c3368fabb1..731c5d83dbbc4b86200d1f063722d22dfbf32ed4 100644 (file)
@@ -1,11 +1,11 @@
 /*
  *  Empire - A multi-player, client/server Internet based war game.
- *  Copyright (C) 1986-2000, Dave Pare, Jeff Bailey, Thomas Ruschak,
- *                           Ken Stevens, Steve McClure
+ *  Copyright (C) 1986-2018, 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,
  *  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/>.
  *
  *  ---
  *
- *  See the "LEGAL", "LICENSE", "CREDITS" and "README" files for all the
- *  related information and legal notices. It is expected that any future
- *  projects/authors will amend these files as needed.
+ *  See files README, COPYING and CREDITS in the root of the source
+ *  tree for related information and legal notices.  It is expected
+ *  that future projects/authors will amend these files as needed.
  *
  *  ---
  *
  *  ioqueue.c: Read and write i/o queues
- * 
+ *
  *  Known contributors to this file:
- *     
+ *
  */
 
 /*
- * Read and write onto io queues.  Note that
- * the io queues don't actually do any writing;
+ * Read and write onto I/O queues.  Note that
+ * the I/O queues don't actually do any writing;
  * that is left for a higher level.
  */
 
-#include <stdio.h>
-#include <stdlib.h> /* malloc free */
-#include <sys/types.h>
-#if !defined(_WIN32)
+#include <config.h>
+
+#include <stdlib.h>
+#include <string.h>
 #include <sys/uio.h>
-#endif
+#include "ioqueue.h"
 #include "misc.h"
 #include "queue.h"
-#include "ioqueue.h"
-
-static int ioqtocbuf(struct ioqueue *ioq, s_char *buf, int cc, register int stopc);
-#if !defined(_WIN32)
-static int ioqtoiov(struct ioqueue *ioq, struct iovec *iov, register int max);
-#endif
-static int ioqtobuf(struct ioqueue *ioq, s_char *buf, int cc);
-static int appendcc(struct ioqueue *ioq, s_char *buf, int cc);
-static int removecc(struct ioqueue *ioq, register int cc);
 
-#if defined(_WIN32)
-static void loc_StripDels(char *pBuf);
-#endif
+struct io {
+    struct emp_qelem queue;
+    int size;
+    int nbytes;
+    int offset;
+    char *data;
+};
+
+struct ioqueue {
+    struct io list;
+    int bufsize;
+    int cc;
+};
+
+static int ioqtocbuf(struct ioqueue *ioq, char *buf, int cc, int stopc);
+static int ioqtoiov(struct ioqueue *ioq, struct iovec *iov, int max);
+static int ioqtobuf(struct ioqueue *ioq, char *buf, int cc);
+static int appendcc(struct ioqueue *ioq, char *buf, int cc);
+static int removecc(struct ioqueue *ioq, int cc);
 
 struct ioqueue *
 ioq_create(int size)
 {
-       struct  ioqueue *ioq;
-
-       ioq = (struct ioqueue *) malloc(sizeof(struct ioqueue));
-       emp_initque(&ioq->list.queue);
-       ioq->list.nbytes = 0;
-       ioq->list.offset = 0;
-       ioq->list.size = 0;
-       ioq->list.data = 0;
-       ioq->bufsize = size;
-       ioq->cc = 0;
-       return ioq;
+    struct ioqueue *ioq;
+
+    ioq = malloc(sizeof(struct ioqueue));
+    emp_initque(&ioq->list.queue);
+    ioq->list.nbytes = 0;
+    ioq->list.offset = 0;
+    ioq->list.size = 0;
+    ioq->list.data = NULL;
+    ioq->bufsize = size;
+    ioq->cc = 0;
+    return ioq;
 }
 
 void
 ioq_destroy(struct ioqueue *ioq)
 {
-#if !defined(aix) && !defined(NeXT) 
-/* ioq_drain doesn't work under aix or NeXT... dunno why --ts */
-       ioq_drain(ioq); 
-#endif /* aix */
-       free((s_char *)ioq);
+    ioq_drain(ioq);
+    free(ioq);
 }
 
 void
 ioq_drain(struct ioqueue *ioq)
 {
-       struct emp_qelem *qp;
-       struct io *io;
+    struct emp_qelem *qp;
+    struct io *io;
+
+    while ((qp = ioq->list.queue.q_forw) != &ioq->list.queue) {
+       io = (struct io *)qp;
+       emp_remque(&io->queue);
+       free(io->data);
+       free(io);
+    }
 
-       while ((qp = ioq->list.queue.q_forw) != &ioq->list.queue){
-               io = (struct io *) qp;
-               (void) emp_remque(&io->queue);
-               (void) free((s_char *)io->data);
-               (void) free((s_char *)io);
-       }
-       
-       ioq->cc = 0;
+    ioq->cc = 0;
 }
 
 /*
@@ -106,15 +109,13 @@ ioq_drain(struct ioqueue *ioq)
  * iovec, but don't actually dequeue the data.
  * return # of iovec initialized.
  */
-#if !defined(_WIN32)
 int
 ioq_makeiov(struct ioqueue *ioq, struct iovec *iov, int cc)
 {
-       if (ioq->cc <= 0)
-               return 0;
-       return ioqtoiov(ioq, iov, cc);
+    if (ioq->cc <= 0)
+       return 0;
+    return ioqtoiov(ioq, iov, cc);
 }
-#endif
 
 /*
  * Copy the specified number of characters into the buffer
@@ -122,27 +123,28 @@ ioq_makeiov(struct ioqueue *ioq, struct iovec *iov, int cc)
  * number of bytes actually found.
  */
 int
-ioq_peek(struct ioqueue *ioq, s_char *buf, int cc)
+ioq_peek(struct ioqueue *ioq, char *buf, int cc)
 {
-       return ioqtobuf(ioq, buf, cc);
+    return ioqtobuf(ioq, buf, cc);
 }
 
-int
+void
 ioq_dequeue(struct ioqueue *ioq, int cc)
 {
-       return removecc(ioq, cc);
+    int res = removecc(ioq, cc);
+    CANT_HAPPEN(res != cc);
 }
 
 void
-ioq_append(struct ioqueue *ioq, s_char *buf, int cc)
+ioq_append(struct ioqueue *ioq, char *buf, int cc)
 {
-       appendcc(ioq, buf, cc);
+    appendcc(ioq, buf, cc);
 }
 
 int
 ioq_qsize(struct ioqueue *ioq)
 {
-       return ioq->cc;
+    return ioq->cc;
 }
 
 /*
@@ -151,306 +153,211 @@ ioq_qsize(struct ioqueue *ioq)
  * no input is available
  */
 int
-ioq_gets(struct ioqueue *ioq, s_char *buf, int cc)
+ioq_gets(struct ioqueue *ioq, char *buf, int cc)
 {
-       int     nbytes;
-       int     actual;
-
-       nbytes = ioqtocbuf(ioq, buf, cc - 1, '\n');
-       if (nbytes >= 0) {
-               actual = nbytes;
-               if (actual > cc - 1)
-                       actual = cc - 1;
-               buf[actual] = '\0';
-               /* remove the newline too */
-               removecc(ioq, nbytes + 1);
-#if defined(_WIN32)
-        loc_StripDels(buf);
-#endif
-       }
-       return nbytes;
+    int nbytes;
+    int actual;
+
+    nbytes = ioqtocbuf(ioq, buf, cc - 1, '\n');
+    if (nbytes >= 0) {
+       actual = nbytes;
+       if (actual > cc - 1)
+           actual = cc - 1;
+       /* telnet terminates lines with "\r\n", get rid of \r */
+       if (actual > 0 && buf[actual-1] == '\r')
+           actual--;
+       buf[actual] = '\0';
+       /* remove the newline too */
+       removecc(ioq, nbytes + 1);
+    }
+    return nbytes;
 }
 
 int
-ioq_puts(struct ioqueue *ioq, s_char *buf)
+ioq_puts(struct ioqueue *ioq, char *buf)
 {
-       return appendcc(ioq, buf, strlen(buf));
+    return appendcc(ioq, buf, strlen(buf));
 }
 
-/*
- * all the rest are local to this module
- */
-
-
 /*
  * copy cc bytes from ioq to buf.
  * this routine doesn't free memory; this is
  * left for a higher level.
  */
-static
-int
-ioqtobuf(struct ioqueue *ioq, s_char *buf, int cc)
+static int
+ioqtobuf(struct ioqueue *ioq, char *buf, int cc)
 {
-       struct io *io;
-       struct emp_qelem *qp;
-       struct emp_qelem *head;
-       register int nbytes;
-       register int nleft;
-       register s_char *offset;
-
-       nleft = cc;
-       offset = buf;
-       head = &ioq->list.queue;
-       for (qp = head->q_forw; qp != head && nleft > 0; qp = qp->q_forw) {
-               io = (struct io *) qp;
-               if ((nbytes = io->nbytes - io->offset) < 0) {
-                       /* XXX log something here */
-                       continue;
-               }
-               if (nbytes > 0) {
-                       if (nleft < nbytes)
-                               nbytes = nleft;
-                       bcopy(io->data + io->offset, offset, nbytes);
-                       offset += nbytes;
-                       nleft -= nbytes;
-               }
+    struct io *io;
+    struct emp_qelem *qp;
+    struct emp_qelem *head;
+    int nbytes, nleft;
+    char *offset;
+
+    nleft = cc;
+    offset = buf;
+    head = &ioq->list.queue;
+    for (qp = head->q_forw; qp != head && nleft > 0; qp = qp->q_forw) {
+       io = (struct io *)qp;
+       if ((nbytes = io->nbytes - io->offset) < 0) {
+           /* XXX log something here */
+           continue;
+       }
+       if (nbytes > 0) {
+           if (nleft < nbytes)
+               nbytes = nleft;
+           memcpy(offset, io->data + io->offset, nbytes);
+           offset += nbytes;
+           nleft -= nbytes;
        }
-       return offset - buf;
+    }
+    return offset - buf;
 }
 
 /*
  * copy at most cc bytes from ioq to buf,
  * terminating on the stop character.
  */
-static
-int
-ioqtocbuf(struct ioqueue *ioq, s_char *buf, int cc, register int stopc)
+static int
+ioqtocbuf(struct ioqueue *ioq, char *buf, int cc, int stopc)
 {
-       register int nbytes;
-       register s_char *p;
-       register int n;
-       struct  io *io;
-       struct  emp_qelem *qp;
-       struct  emp_qelem *head;
-       int     total;
-       int     found;
-
-       head = &ioq->list.queue;
-       found = 0;
-       total = 0;
-       for (qp = head->q_forw; qp != head; qp = qp->q_forw) {
-               io = (struct io *) qp;
-               if ((nbytes = io->nbytes - io->offset) <= 0)
-                       continue;
-               p = io->data + io->offset;
-               for (n=0; n < nbytes && p[n] != stopc; n++)
-                       ;
-               total += n;
-               if (n < nbytes) {
-                       found++;
-                       break;
-               }
+    int nbytes;
+    char *p;
+    int n;
+    struct io *io;
+    struct emp_qelem *qp;
+    struct emp_qelem *head;
+    int total;
+    int found;
+
+    head = &ioq->list.queue;
+    found = 0;
+    total = 0;
+    for (qp = head->q_forw; qp != head; qp = qp->q_forw) {
+       io = (struct io *)qp;
+       if ((nbytes = io->nbytes - io->offset) <= 0)
+           continue;
+       p = io->data + io->offset;
+       for (n = 0; n < nbytes && p[n] != stopc; n++) ;
+       total += n;
+       if (n < nbytes) {
+           found++;
+           break;
        }
-       if (found == 0)
-               return -1;
-       ioqtobuf(ioq, buf, cc < total ? cc : total);
-       return total;
+    }
+    if (found == 0)
+       return -1;
+    ioqtobuf(ioq, buf, cc < total ? cc : total);
+    return total;
 }
 
 /*
  * initialize an iovec to point at max bytes worth
  * of data from the ioqueue.
  */
-#if !defined(_WIN32)
-static
-int
-ioqtoiov(struct ioqueue *ioq, struct iovec *iov, register int max)
+static int
+ioqtoiov(struct ioqueue *ioq, struct iovec *iov, int max)
 {
-       struct io *io;
-       register int cc;
-       register int niov;
-       register int len;
-       struct  emp_qelem *qp;
-
-       cc = max;
-       niov = 0;
-       qp = ioq->list.queue.q_forw;
-       while (qp != &ioq->list.queue && cc > 0) {
-               io = (struct io *) qp;
-               len = io->nbytes - io->offset;
-               if (len > cc)
-                       len = cc;
-               iov->iov_base = io->data + io->offset;
-               iov->iov_len = len;
-               cc -= len;
-               niov++;
-               iov++;
-               qp = qp->q_forw;
-               if (niov >= 16)
-                       break;
-       }
-       return niov;
+    struct io *io;
+    int cc, niov, len;
+    struct emp_qelem *qp;
+
+    cc = max;
+    niov = 0;
+    qp = ioq->list.queue.q_forw;
+    while (qp != &ioq->list.queue && cc > 0) {
+       io = (struct io *)qp;
+       len = io->nbytes - io->offset;
+       if (len > cc)
+           len = cc;
+       iov->iov_base = io->data + io->offset;
+       iov->iov_len = len;
+       cc -= len;
+       niov++;
+       iov++;
+       qp = qp->q_forw;
+       if (niov >= 16)
+           break;
+    }
+    return niov;
 }
-#endif
 
 /*
  * append a buffer to the end of the ioq.
  */
-static
-int
-appendcc(struct ioqueue *ioq, s_char *buf, int cc)
+static int
+appendcc(struct ioqueue *ioq, char *buf, int cc)
 {
-       struct io *io;
-       int     len;
-       s_char  *ptr;
-       int     avail;
-
-       /* determine if any space is left */
-       io = (struct io *)ioq->list.queue.q_back;
-       avail = io->size - io->nbytes;
-       if (avail > 0) {
-               /* append to existing buffer */
-               len = cc > avail ? avail : cc;
-               bcopy(buf, io->data + io->nbytes, len);
-               io->nbytes += len;
-               ioq->cc += len;
-               if (avail < cc)
-                       appendcc(ioq, buf + len, cc - len);
-       } else {
-               /* create a new buffer, minimum bufsize bytes */
-               len = cc > ioq->bufsize ? cc : ioq->bufsize;
-               ptr = malloc(len);
-               bcopy(buf, ptr, cc);
-               io = (struct io *) malloc(sizeof(struct io));
-               io->nbytes = cc;
-               io->size = len;
-               io->offset = 0;
-               io->data = ptr;
-               emp_insque(&io->queue, ioq->list.queue.q_back);
-               ioq->cc += cc;
-       }
-       return cc;
+    struct io *io;
+    int len;
+    char *ptr;
+    int avail;
+
+    /* determine if any space is left */
+    io = (struct io *)ioq->list.queue.q_back;
+    avail = io->size - io->nbytes;
+    if (avail > 0) {
+       /* append to existing buffer */
+       len = cc > avail ? avail : cc;
+       memcpy(io->data + io->nbytes, buf, len);
+       io->nbytes += len;
+       ioq->cc += len;
+       if (avail < cc)
+           appendcc(ioq, buf + len, cc - len);
+    } else {
+       /* create a new buffer, minimum bufsize bytes */
+       len = cc > ioq->bufsize ? cc : ioq->bufsize;
+       ptr = malloc(len);
+       memcpy(ptr, buf, cc);
+       io = malloc(sizeof(struct io));
+       io->nbytes = cc;
+       io->size = len;
+       io->offset = 0;
+       io->data = ptr;
+       emp_insque(&io->queue, ioq->list.queue.q_back);
+       ioq->cc += cc;
+    }
+    return cc;
 }
 
 /*
  * remove cc bytes from ioqueue ioq
- * free memory, dequeue io elements
+ * free memory, dequeue I/O elements
  * which are no longer used.
  */
-static
-int
-removecc(struct ioqueue *ioq, register int cc)
+static int
+removecc(struct ioqueue *ioq, int cc)
 {
-       struct io *io;
-       struct emp_qelem *qp;
-       register int nbytes;
-       register int there;
-       register int remain;
-
-       nbytes = 0;
-       remain = cc;
-       while ((qp = ioq->list.queue.q_forw) != &ioq->list.queue) {
-               io = (struct io *) qp;
-               there = io->nbytes - io->offset;
-               if (there < 0) {
-                       /* error */
-                       (void) emp_remque(&io->queue);
-                       (void) free((s_char *)io);
-                       continue;
-               }
-               if (remain >= there) {
-                       /* not enough or exact; free entry */
-                       nbytes += there;
-                       remain -= there;
-                       (void) emp_remque(&io->queue);
-                       (void) free(io->data);
-                       (void) free((s_char *)io);
-               } else {
-                       /* too much; increment offset */
-                       io->offset += remain;
-                       nbytes += remain;
-                       remain = 0;
-               }
-               if (remain <= 0)
-                       break;
+    struct io *io;
+    struct emp_qelem *qp;
+    int nbytes, there, remain;
+
+    nbytes = 0;
+    remain = cc;
+    while ((qp = ioq->list.queue.q_forw) != &ioq->list.queue) {
+       io = (struct io *)qp;
+       there = io->nbytes - io->offset;
+       if (there < 0) {
+           /* error */
+           emp_remque(&io->queue);
+           free(io);
+           continue;
        }
-       ioq->cc -= nbytes;
-       return nbytes;
-}
-#if defined(_WIN32)
-/*
- * Make an (output) buffer up to the
- * maximum size of the buffer.
- *
- * We don't free the bytes...
- */
-int
-ioq_makebuf(struct ioqueue *ioq, char *pBuf, int nBufLen)
-{
-       struct io *io;
-       struct emp_qelem *qp;
-       struct emp_qelem *head;
-       int nbytes;
-       int nleft;
-    int ncopied;
-       s_char *offset;
-
-    ncopied = 0;
-       nleft = nBufLen;
-       offset = pBuf;
-       head = &ioq->list.queue;
-
-       for (qp = head->q_forw;
-                    (qp != head) && (nleft > 0);
-                    qp = qp->q_forw) {
-               io = (struct io *) qp;
-               nbytes = io->nbytes - io->offset;
-               if (nbytes < 0) {
-            /* Paranoid check for bad buffer. */
-                       continue;
-               }
-
-        /* too many bytes, wait till next time. */
-        if (nbytes > nleft)
-            break;
-
-               bcopy(io->data + io->offset, offset, nbytes);
-               offset += nbytes;
-               nleft -= nbytes;
-        ncopied += nbytes;
+       if (remain >= there) {
+           /* not enough or exact; free entry */
+           nbytes += there;
+           remain -= there;
+           emp_remque(&io->queue);
+           free(io->data);
+           free(io);
+       } else {
+           /* too much; increment offset */
+           io->offset += remain;
+           nbytes += remain;
+           remain = 0;
        }
-       return ncopied;
-}
-#endif /* _WIN32 */
-
-#if defined(_WIN32)
-/*
- * Remove backspaces and DELs from the buffer.
- *
- * Why?  Because I got tired of telneting into the
- * server and having to type perfectly...
- */
-static void
-loc_StripDels(char *pBuf)
-{
-    char *cp;
-    char *dp;
-    char *sp;
-
-    for (cp = pBuf; *cp;) {
-        /* Remove Backspace and DEL */
-        if (*cp == '\b' || *cp == '\x8F') {
-            if (cp == pBuf)
-                dp = cp;
-            else
-                dp = cp - 1;
-            sp = cp + 1;
-            while (*sp)
-                *dp++ = *sp++;
-            *dp = 0;
-        } else
-            cp++;
+       if (remain <= 0)
+           break;
     }
+    ioq->cc -= nbytes;
+    return nbytes;
 }
-#endif
-