]> git.pond.sub.org Git - empserver/blobdiff - src/lib/lwp/lwp.c
Update known contributors comments
[empserver] / src / lib / lwp / lwp.c
index f29eaf4b20c0a6beac1cdeede8d9396fdea922ab..8c97162637f1576c0aee6b4ff4106fc3b46b7623 100644 (file)
@@ -1,44 +1,52 @@
 /*
- * lwp.c -- lightweight process creation, destruction and manipulation.
- * Copyright (C) 1991-3 Stephen Crane.
+ *  Empire - A multi-player, client/server Internet based war game.
+ *  Copyright (C) 1994-2009, Dave Pare, Jeff Bailey, Thomas Ruschak,
+ *                           Ken Stevens, Steve McClure
+ *  Copyright (C) 1991-3 Stephen Crane
  *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Library General Public
- * License as published by the Free Software Foundation; either
- * version 2 of the License, or (at your option) any later version.
- * 
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * Library General Public License for more details.
- * 
- * You should have received a copy of the GNU Library General Public
- * License along with this library; if not, write to the Free
- * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ *  This program 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
+ *  (at your option) any later version.
  *
- * author: Stephen Crane, (jsc@doc.ic.ac.uk), Department of Computing,
- * Imperial College of Science, Technology and Medicine, 180 Queen's
- * Gate, London SW7 2BZ, England.
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  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
+ *
+ *  ---
+ *
+ *  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.
+ *
+ *  ---
+ *
+ *  lwp.c: lightweight process creation, destruction and manipulation
+ *
+ *  Known contributors to this file:
+ *     Markus Armbruster, 2004-2009
  */
 
-#include <stdio.h>
-#include <signal.h>
-#include <stdlib.h>
+#include <config.h>
+
 #include <string.h>
 #include "lwp.h"
 #include "lwpint.h"
 #include "prototypes.h"
 
-#if defined(_EMPTH_LWP)
-
-struct lwpQueue LwpSchedQ[LWP_MAX_PRIO], LwpDeadQ;
+static struct lwpQueue LwpSchedQ[LWP_MAX_PRIO], LwpDeadQ;
 
 struct lwpProc *LwpCurrent = NULL;
-char **LwpContextPtr;
-int LwpMaxpri = 0;             /* maximum priority so far */
-
-static sigset_t oldmask;
+static void **LwpContextPtr;
+static int LwpMaxpri = 0;      /* maximum priority so far */
+static int LwpStackGrowsDown;
 
+static void lwpDestroy(struct lwpProc *proc);
 static void lwpStackCheckInit(struct lwpProc *newp);
 static void lwpStackCheck(struct lwpProc *newp);
 static void lwpStackCheckUsed(struct lwpProc *newp);
@@ -59,29 +67,21 @@ growsdown(void *x)
 void
 lwpReschedule(void)
 {
-    static int lcount = LCOUNT;
     static struct lwpProc *nextp;
     static int i;
-    static sigset_t tmask;
 
     if (LwpCurrent && (LwpCurrent->flags & LWP_STACKCHECK)) {
        lwpStackCheck(LwpCurrent);
     }
-    if (!--lcount) {
-       int p = lwpSetPriority(LWP_MAX_PRIO - 1);
-       lcount = LCOUNT;
-       sigprocmask(SIG_SETMASK, &oldmask, &tmask);
-       sigprocmask(SIG_SETMASK, &tmask, &oldmask);
-       LwpCurrent->pri = p;
-    }
+
+    lwpSigWakeup();
+    lwpWakeupSleep();
 
     /* destroy dead threads */
     lwpStatus(LwpCurrent, "Cleaning dead queue");
     while (NULL != (nextp = lwpGetFirst(&LwpDeadQ))) {
-       if (nextp == LwpCurrent) {
-           lwpStatus(nextp, "OOOPS, we are running already dead thread");
-           exit(1);
-       }
+       if (CANT_HAPPEN(nextp == LwpCurrent))
+           abort();
        lwpDestroy(nextp);
        lwpStatus(LwpCurrent, "Destroying done");
     }
@@ -98,25 +98,21 @@ lwpReschedule(void)
            } else {
                lwpDestroy(nextp);
            }
-           nextp = 0;
+           nextp = NULL;
        }
        if (nextp)
            break;
     }
-    if (LwpCurrent == 0 && nextp == 0) {
-       fprintf(stderr, "No processes to run!\n");
-       exit(1);
-    }
-    if (LwpCurrent)
-       lwpStatus(LwpCurrent, "switch out");
-    /* do context switch */
-    i = LwpCurrent && lwpSave(LwpCurrent->context);
-    if (LwpCurrent != nextp && !i) {
-       /* restore previous context */
-       lwpStatus(nextp, "switch in %d", nextp->pri);
+    if (CANT_HAPPEN(!LwpCurrent && !nextp))
+       abort();
+    if (LwpCurrent != nextp) {
+       struct lwpProc *oldp = LwpCurrent;
+       if (oldp)
+           lwpStatus(oldp, "switch out");
        LwpCurrent = nextp;
-       *LwpContextPtr = LwpCurrent->ud;
-       lwpRestore(LwpCurrent->context);
+       *LwpContextPtr = nextp->ud;
+       lwpSwitchContext(oldp, nextp);
+       lwpStatus(nextp, "switch in");
     }
 }
 
@@ -126,110 +122,77 @@ lwpReschedule(void)
 void
 lwpEntryPoint(void)
 {
-    sigset_t set;
-
-    sigemptyset(&set);
-    sigaddset(&set, SIGALRM);
-    sigprocmask(SIG_SETMASK, &set, &oldmask);
-    *LwpContextPtr = LwpCurrent->ud;
-
     lwpStatus(LwpCurrent, "starting at entry point");
     (*LwpCurrent->entry)(LwpCurrent->ud);
     lwpExit();
 }
 
+static int
+lwpNewStack(struct lwpProc *newp, int stacksz)
+{
+    char *s;
+    int size, redsize;
+
+    /* Make size a multiple of sizeof(long) to keep things aligned */
+    stacksz = (stacksz + sizeof(long) - 1) & -sizeof(long);
+    /* Add a red zone on each side of the stack for LWP_STACKCHECK */
+    redsize = newp->flags & LWP_STACKCHECK ? LWP_REDZONE : 0;
+    size = stacksz + 2 * redsize;
+
+    s = malloc(size);
+    if (!s)
+       return -1;
+
+    newp->sbtm = s;
+    newp->size = size;
+    newp->ustack = s + redsize;
+    newp->usize = stacksz;
+
+    if (newp->flags & LWP_STACKCHECK)
+       lwpStackCheckInit(newp);
+    return 0;
+}
+
 /*
  * lwpCreate -- create a process.
  */
 struct lwpProc *
-lwpCreate(int priority, void (*entry)(void *), int stacksz, int flags, char *name, char *desc, int argc, char **argv, void *ud)
+lwpCreate(int priority, void (*entry)(void *), int stacksz,
+         int flags, char *name, int argc, char **argv, void *ud)
 {
     struct lwpProc *newp;
-    char *s, *sp;
-    int size, redsize, x;
-#ifdef UCONTEXT
-    stack_t usp;
-#endif /* UCONTEXT */
-
-    if (CANT_HAPPEN(STKALIGN == 0|| (STKALIGN & (STKALIGN - 1))))
-       return NULL;            /* STKALIGN not power of 2 */
+
     if (!(newp = malloc(sizeof(struct lwpProc))))
-       return 0;
-    /* Make size a multiple of sizeof(long) to things aligned */
-    stacksz = (stacksz + sizeof(long) - 1) & -sizeof(long);
-    /* Add a red zone on each side of the stack for LWP_STACKCHECK */
-    redsize = flags & LWP_STACKCHECK ? LWP_REDZONE : 0;
-    size = stacksz + 2 * redsize + LWP_EXTRASTACK + STKALIGN - 1;
-    if (!(s = malloc(size)))
-       return 0;
+       return NULL;
     newp->flags = flags;
     newp->name = strdup(name);
-    newp->desc = strdup(desc);
     newp->entry = entry;
     newp->argc = argc;
     newp->argv = argv;
     newp->ud = ud;
-    if (growsdown(&x)) {
-       /*
-        * Stack layout for stack growing downward:
-        *     ptr        block      size
-        *     --------------------------------------
-        *                waste      x
-        *     lowmark -> red zone   LWP_REDZONE
-        *     sp      -> extra      LWP_EXTRASTACK
-        *                stack      stacksz
-        *     himark  -> red zone   LWP_EXTRASTACK
-        *                waste      STKALIGN - 1 - x
-        * sp is aligned to a multiple of STKALIGN.
-        */
-       sp = s + redsize + stacksz;
-       sp = (char *)0 + (((sp + STKALIGN - 1) - (char *)0) & -STKALIGN);
-       newp->lowmark = sp + LWP_EXTRASTACK;
-       newp->himark = sp - stacksz - redsize;
-    } else {
-       /*
-        * Stack layout for stack growing upward:
-        *     ptr        block      size
-        *     --------------------------------------
-        *                waste      x
-        *     himark  -> red zone   LWP_REDZONE
-        *                extra      LWP_EXTRASTACK
-        *     sp      -> stack      stacksz
-        *     lowmark -> red zone   LWP_EXTRASTACK
-        *                waste      STKALIGN - 1 - x
-        * sp is aligned to a multiple of STKALIGN.
-        */
-       sp = s + redsize + LWP_EXTRASTACK;
-       sp = (char *)0 + (((sp + STKALIGN - 1) - (char *)0) & -STKALIGN);
-       newp->lowmark = sp - LWP_EXTRASTACK - redsize;
-       newp->himark = sp + size;
-    }
+    newp->dead = 0;
+    newp->runtime = (time_t)-1;
+    newp->fd = -1;
+    newp->sbtm = NULL;
     if (LWP_MAX_PRIO <= priority)
        priority = LWP_MAX_PRIO - 1;
     if (LwpMaxpri < (newp->pri = priority))
        LwpMaxpri = priority;
-    newp->sbtm = s;
-    newp->size = size;
-    newp->dead = 0;
-    if (flags & LWP_STACKCHECK)
-       lwpStackCheckInit(newp);
-    lwpStatus(newp, "creating process structure sbtm: %p",
-             newp->sbtm);
+    if (lwpNewStack(newp, stacksz) < 0 || lwpNewContext(newp) < 0) {
+       free(newp->sbtm);
+       free(newp->name);
+       free(newp);
+       return NULL;
+    }
+    lwpStatus(newp, "creating process structure %p (sbtm %p)",
+             newp, newp->sbtm);
     lwpReady(newp);
     lwpReady(LwpCurrent);
-#ifdef UCONTEXT
-    usp.ss_sp = s + redsize;
-    usp.ss_size = stacksz;
-    usp.ss_flags = 0;
-    lwpInitContext(newp, &usp);        /* architecture-dependent: from arch.c */
-#else  /* UCONTEXT */
-    lwpInitContext(newp, sp);  /* architecture-dependent: from arch.c */
-#endif /* UCONTEXT */
     lwpReschedule();
     return newp;
 }
 
-void
+static void
 lwpDestroy(struct lwpProc *proc)
 {
     if (proc->flags & LWP_STACKCHECK) {
@@ -237,17 +200,8 @@ lwpDestroy(struct lwpProc *proc)
        lwpStackCheck(proc);
     }
     lwpStatus(proc, "destroying sbtm: %p", proc->sbtm);
-    proc->entry = 0;
-    proc->ud = 0;
-    proc->argv = 0;
     free(proc->sbtm);
     free(proc->name);
-    free(proc->desc);
-    proc->name = 0;
-    proc->desc = 0;
-    proc->sbtm = 0;
-    proc->lowmark = 0;
-    proc->himark = 0;
     free(proc);
 }
 
@@ -285,20 +239,6 @@ lwpSetUD(struct lwpProc *p, char *ud)
     p->ud = ud;
 }
 
-/*
- * set name & desc
- */
-void
-lwpSetDesc(struct lwpProc *p, char *name, char *desc)
-{
-    if (!p)
-       p = LwpCurrent;
-    free(p->name);
-    free(p->desc);
-    p->name = strdup(name);
-    p->desc = strdup(desc);
-}
-
 /*
  * lwpYield -- yield the processor to another thread.
  */
@@ -330,8 +270,7 @@ lwpTerminate(struct lwpProc *p)
 {
     lwpStatus(p, "terminating process");
     p->dead = 1;
-    if (p->fd >= 0)
-       lwpWakeupFd(p);
+    lwpWakeup(p);
 }
 
 /*
@@ -358,36 +297,37 @@ lwpSetPriority(int new)
  * initialise the coroutine structures
  */
 struct lwpProc *
-lwpInitSystem(int pri, char **ctxptr, int flags)
+lwpInitSystem(int pri, void **ctxptr, int flags, sigset_t *waitset)
 {
     struct lwpQueue *q;
-    int i, *stack;
+    int i, *stack, marker;
     struct lwpProc *sel;
 
     LwpContextPtr = ctxptr;
     if (pri < 1)
        pri = 1;
-    /* *LwpContextPtr = 0; */
+    LwpStackGrowsDown = growsdown(&marker);
     if (!(LwpCurrent = calloc(1, sizeof(struct lwpProc))))
-       return 0;
+       return NULL;
     if (!(stack = malloc(64)))
-       return 0;
+       return NULL;
     if (LWP_MAX_PRIO <= pri)
        pri = LWP_MAX_PRIO - 1;
     if (LwpMaxpri < pri)
        LwpMaxpri = pri;
-    LwpCurrent->next = 0;
+    LwpCurrent->next = NULL;
     LwpCurrent->sbtm = stack;  /* dummy stack for "main" */
     LwpCurrent->pri = pri;
     LwpCurrent->dead = 0;
     LwpCurrent->flags = flags & ~LWP_STACKCHECK;
     LwpCurrent->name = "Main";
     for (i = LWP_MAX_PRIO, q = LwpSchedQ; i--; q++)
-       q->head = q->tail = 0;
-    LwpDeadQ.head = LwpDeadQ.tail = 0;
+       q->head = q->tail = NULL;
+    LwpDeadQ.head = LwpDeadQ.tail = NULL;
+    lwpInitSigWait(waitset);
     /* must be lower in priority than us for this to work right */
-    sel = lwpCreate(0, lwpSelect, 16384, flags, "EventHandler",
-                   "Select (main loop) Event Handler", 0, 0, 0);
+    sel = lwpCreate(0, lwpSelect, 16384, flags, "EventHandler", 0,
+                   NULL, NULL);
     lwpInitSelect(sel);
     return LwpCurrent;
 }
@@ -401,15 +341,11 @@ lwpInitSystem(int pri, char **ctxptr, int flags)
 static void
 lwpStackCheckInit(struct lwpProc *newp)
 {
-    register int i;
-    register long *lp;
-
-    int lim = newp->size / sizeof(long);
-    if (!newp || !newp->sbtm)
-       return;
-    for (lp = newp->sbtm, i = 0; i < lim; i++, lp++) {
-       *lp = LWP_CHECKMARK;
-    }
+    int *p;
+    int *lim = (int *)((char *)newp->sbtm + newp->size);
+
+    for (p = newp->sbtm; p < lim; p++)
+       *p = LWP_CHECKMARK;
 }
 
 /* lwpStackCheck
@@ -420,57 +356,32 @@ lwpStackCheckInit(struct lwpProc *newp)
 static void
 lwpStackCheck(struct lwpProc *newp)
 {
-    register int end, amt;
-    register unsigned int i;
-    register long *lp;
-    register int growsDown;
-    int marker;
-
-    if (CANT_HAPPEN(!newp || !newp->himark || !newp->lowmark))
-       return;
-    growsDown = growsdown(&marker);
-    for (lp = newp->himark, i = 0; i < LWP_REDZONE / sizeof(long);
-        i++, lp++) {
-       if (*lp == LWP_CHECKMARK)
-           continue;
-       /* Stack overflow. */
-       if (growsDown) {
-           end = i;
-           while (i < LWP_REDZONE / sizeof(long)) {
-               if (*lp++ != LWP_CHECKMARK)
-                   end = i;
-               i++;
-           }
-           amt = (end + 1) * sizeof(long);
-       } else {
-           amt = (i + 1) * sizeof(long);
-       }
-       logerror("Thread %s stack overflow %d bytes (of %u)",
-                newp->name, amt,
-                newp->size - 2 * LWP_REDZONE - (int)STKALIGN);
-       abort();
+    int *btm = (int *)(newp->ustack - LWP_REDZONE);
+    int *top = (int *)(newp->ustack + newp->usize + LWP_REDZONE);
+    int n = LWP_REDZONE / sizeof(int);
+    int i, lo_clean, hi_clean, overflow, underflow;
+
+    for (i = 0; i < n && btm[i] == LWP_CHECKMARK; i++) ;
+    lo_clean = i;
+
+    for (i = 1; i <= n && top[-i] == LWP_CHECKMARK; i++) ;
+    hi_clean = i - 1;
+
+    if (LwpStackGrowsDown) {
+       overflow = n - lo_clean;
+       underflow = n - hi_clean;
+    } else {
+       overflow = n - hi_clean;
+       underflow = n - lo_clean;
     }
-    for (lp = newp->lowmark, i = 0; i < LWP_REDZONE / sizeof(long);
-        i++, lp++) {
-       if (*lp == LWP_CHECKMARK)
-           continue;
-       /* Stack underflow. */
-       if (growsDown) {
-           end = i;
-           while (i < LWP_REDZONE / sizeof(long)) {
-               if (*lp++ != LWP_CHECKMARK)
-                   end = i;
-               i++;
-           }
-           amt = (end + 1) * sizeof(long);
-       } else {
-           amt = (LWP_REDZONE - i + 1) * sizeof(long);
-       }
-       logerror("Thread %s stack underflow %d bytes (of %u)",
-                 newp->name, amt,
-                newp->size - 2 * LWP_REDZONE - (int)STKALIGN);
+    if (overflow)
+       logerror("Thread %s stack overflow %d bytes",
+                newp->name, overflow * (int)sizeof(int));
+    if (underflow)
+       logerror("Thread %s stack underflow %d bytes",
+                newp->name, underflow * (int)sizeof(int));
+    if (overflow || underflow)
        abort();
-    }
 }
 
 /* lwpStackCheckUsed
@@ -480,36 +391,42 @@ lwpStackCheck(struct lwpProc *newp)
 static void
 lwpStackCheckUsed(struct lwpProc *newp)
 {
-    register int i;
-    register long *lp;
-    register int lim;
-    int marker;
-
-    if (!newp || !newp->sbtm)
-       return;
-    lim = newp->size / sizeof(long);
-    if (growsdown(&marker)) {
-       /* Start at the bottom and find first non checkmark. */
-       for (lp = newp->sbtm, i = 0; i < lim; i++, lp++) {
-           if (*lp != LWP_CHECKMARK) {
-               break;
-           }
-       }
+    int *base = (int *)newp->ustack;
+    int *lim = (int *)(newp->ustack + newp->usize);
+    int total = (lim + 1 - base) * sizeof(int);
+    int used, *p;
+
+    if (LwpStackGrowsDown) {
+       for (p = base; p < lim && *p == LWP_CHECKMARK; ++p) ;
+       used = (lim - p) * sizeof(int);
     } else {
-       /* Start at the top and find first non checkmark. */
-       lp = newp->sbtm;
-       lp += newp->size / sizeof(long);
-       lp--;
-       for (i = 0; i < lim; i++, lp--) {
-           if (*lp != LWP_CHECKMARK) {
-               break;
-           }
-       }
+       for (p = lim - 1; p >= base && *p == LWP_CHECKMARK; --p) ;
+       used = (p - base + 1) * sizeof(int);
     }
-    lwpStatus(newp, "Thread stack %lu used %lu left %lu total",
-             labs((char *)lp - (char *)newp->lowmark) - LWP_REDZONE,
-             labs((char *)newp->himark - (char *)lp) - LWP_REDZONE,
-             labs((char *)newp->himark - (char *)newp->lowmark) - LWP_REDZONE);
+    lwpStatus(newp, "Thread stack %d used, %d left, %d total",
+             used, total - used, total);
+}
+
+/* lwpName
+ *
+ * Return the name of the thread.
+ */
+char *
+lwpName(struct lwpProc *proc)
+{
+    return proc->name;
+}
+
+/* lwpSetName
+ *
+ * Set the name of the thread.
+ */
+void
+lwpSetName(struct lwpProc *proc, char *name)
+{
+    if (proc->name != NULL)
+       free(proc->name);
+
+    proc->name = strdup(name);
 }
 
-#endif