]> git.pond.sub.org Git - empserver/blobdiff - src/lib/empthread/pthread.c
Reimplement max_idle without a separate thread
[empserver] / src / lib / empthread / pthread.c
index 8512a4683b6c6f49bc2741296fa73d29dae5b4dc..57a887ff891e914f158ab3a3b846ab1a4af88863 100644 (file)
@@ -1,6 +1,6 @@
 /*
  *  Empire - A multi-player, client/server Internet based war game.
- *  Copyright (C) 1986-2006, Dave Pare, Jeff Bailey, Thomas Ruschak,
+ *  Copyright (C) 1986-2008, Dave Pare, Jeff Bailey, Thomas Ruschak,
  *                           Ken Stevens, Steve McClure
  *
  *  This program is free software; you can redistribute it and/or modify
  *
  *  ---
  *
- *  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.
  *
  *  ---
  *
  *  pthread.c: Interface from Empire threads to POSIX threads
- * 
+ *
  *  Known contributors to this file:
  *     Sasha Mikheev
  *     Steve McClure, 1998
+ *     Markus Armbruster, 2005-2007
+ *     Ron Koenderink, 2007
  */
 
+/* Required for PTHREAD_STACK_MIN on some systems, e.g. Solaris: */
+#define _XOPEN_SOURCE 500
+
 #include <config.h>
 
+#include <errno.h>
+#include <limits.h>
+#include <pthread.h>
+#include <signal.h>
+#include <stdarg.h>
 #include <stdio.h>
-#if !defined(_WIN32)
+#include <stdlib.h>
+#include <string.h>
+#include <sys/types.h>
 #include <sys/time.h>
 #include <unistd.h>
-#endif
-#include <sys/types.h>
-#include <signal.h>
-#include <errno.h>
-#include <string.h>
-#include <limits.h>
 
 #include "misc.h"
 #include "empthread.h"
 #include "prototypes.h"
 
-#include <stdarg.h>
-
 #define EMPTH_KILLED  1
+#define EMPTH_INTR 2
 
 struct empth_t {
     char *name;                        /* thread name */
-    char *desc;                        /* description */
     void *ud;                  /* user data */
     int state;                 /* my state */
     void (*ep)(void *);                /* entry point */
     pthread_t id;              /* thread id */
 };
 
-struct empth_sem_t {
-    pthread_mutex_t mtx_update;        /* use it to update count */
-    int count;
-    char name[80];
-    pthread_mutex_t mtx_sem;
-    pthread_cond_t cnd_sem;
+struct empth_rwlock_t {
+    char *name;
+    pthread_rwlock_t lock;
 };
 
 /* Thread-specific data key */
@@ -87,31 +88,14 @@ static void **udata;
  */
 static pthread_mutex_t mtx_ctxsw;
 
-static void empth_status(char *format, ...) ATTRIBUTE((format (printf, 1, 2)));
+static void empth_status(char *format, ...)
+    ATTRIBUTE((format (printf, 1, 2)));
 static void empth_alarm(int sig);
 
 static void *
 empth_start(void *arg)
 {
     empth_t *ctx = arg;
-    struct sigaction act;
-
-    /* actually it should inherit all this from main but... */
-    act.sa_flags = 0;
-    sigemptyset(&act.sa_mask);
-    act.sa_handler = shutdwn;
-    sigaction(SIGTERM, &act, NULL);
-    sigaction(SIGINT, &act, NULL);
-    act.sa_handler = panic;
-    sigaction(SIGBUS, &act, NULL);
-    sigaction(SIGSEGV, &act, NULL);
-    sigaction(SIGILL, &act, NULL);
-    sigaction(SIGFPE, &act, NULL);
-    act.sa_handler = SIG_IGN;
-    sigaction(SIGPIPE, &act, NULL);
-
-    act.sa_handler = empth_alarm;
-    sigaction(SIGALRM, &act, NULL);
 
     ctx->id = pthread_self();
     pthread_setspecific(ctx_key, ctx);
@@ -157,70 +141,68 @@ int
 empth_init(void **ctx_ptr, int flags)
 {
     empth_t *ctx;
+    sigset_t set;
     struct sigaction act;
 
+    empth_flags = flags;
+    udata = ctx_ptr;
 
-    pthread_key_create(&ctx_key, NULL);
-    pthread_mutex_init(&mtx_ctxsw, NULL);
-
+    empth_init_signals();
+    sigemptyset(&set);
+    sigaddset(&set, SIGHUP);
+    sigaddset(&set, SIGINT);
+    sigaddset(&set, SIGTERM);
+    pthread_sigmask(SIG_BLOCK, &set, NULL);
     act.sa_flags = 0;
     sigemptyset(&act.sa_mask);
     act.sa_handler = empth_alarm;
     sigaction(SIGALRM, &act, NULL);
 
-    udata = ctx_ptr;
+    pthread_key_create(&ctx_key, NULL);
+    pthread_mutex_init(&mtx_ctxsw, NULL);
+
     ctx = malloc(sizeof(empth_t));
     if (!ctx) {
        logerror("pthread init failed: not enough memory");
        exit(1);
     }
     ctx->name = "Main";
-    ctx->desc = "empire main";
     ctx->ep = 0;
     ctx->ud = 0;
     ctx->id = pthread_self();
     ctx->state = 0;
     pthread_setspecific(ctx_key, ctx);
     pthread_mutex_lock(&mtx_ctxsw);
-    empth_flags = flags;
     logerror("pthreads initialized");
     return 0;
 }
 
 
-/*
- * prio can be used for setting scheeduling policy but...
- * it seems to be optional in POSIX threads and Solaris
- * for example just ignores it.
- * More then that priority is not needed even in lwp threads.
- */
 empth_t *
-empth_create(int prio, void (*entry)(void *), int size, int flags,
-            char *name, char *desc, void *ud)
+empth_create(void (*entry)(void *), int size, int flags,
+            char *name, void *ud)
 {
     pthread_t t;
     pthread_attr_t attr;
     empth_t *ctx;
     int eno;
 
-    empth_status("creating new thread %s:%s", name, desc);
+    empth_status("creating new thread %s", name);
 
     ctx = malloc(sizeof(empth_t));
     if (!ctx) {
-       logerror("not enough memory to create thread: %s (%s)", name,
-                desc);
+       logerror("not enough memory to create thread %s", name);
        return NULL;
     }
     ctx->name = strdup(name);
-    ctx->desc = strdup(desc);
     ctx->ud = ud;
     ctx->state = 0;
     ctx->ep = entry;
 
     eno = pthread_attr_init(&attr);
     if (eno) {
-       logerror("can not create thread attribute %s (%s): %s", name, desc,
-                strerror(eno));
+       logerror("can not create thread attribute %s: %s",
+                name, strerror(eno));
        goto bad;
     }
     if (size < PTHREAD_STACK_MIN)
@@ -230,11 +212,11 @@ empth_create(int prio, void (*entry)(void *), int size, int flags,
 
     eno = pthread_create(&t, &attr, empth_start, ctx);
     if (eno) {
-       logerror("can not create thread: %s (%s): %s", name, desc,
-                strerror(eno));
+       logerror("can not create thread: %s: %s", name, strerror(eno));
        goto bad;
     }
     empth_status("new thread id is %ld", (long)t);
+    empth_yield();
     return ctx;
 
   bad:
@@ -255,6 +237,7 @@ empth_restorectx(void)
        empth_status("i am dead");
        empth_exit();
     }
+    ctx_ptr->state = 0;
     empth_status("context restored");
 }
 
@@ -264,23 +247,29 @@ empth_self(void)
     return pthread_getspecific(ctx_key);
 }
 
+char *
+empth_name(empth_t *thread)
+{
+    return thread->name;
+}
+
+void
+empth_set_name(empth_t *thread, char *name)
+{
+    if (thread->name)
+       free(thread->name);
+    thread->name = strdup(name);
+}
+
 void
 empth_exit(void)
 {
-    empth_t *ctx_ptr;
+    empth_t *ctx = pthread_getspecific(ctx_key);
 
-    pthread_mutex_unlock(&mtx_ctxsw);
     empth_status("empth_exit");
-    ctx_ptr = pthread_getspecific(ctx_key);
-    /* We want to leave the main thread around forever, until it's time
-       for it to die for real (in a shutdown) */
-    if (!strcmp(ctx_ptr->name, "Main")) {
-       while (1) {
-           sleep(60);
-       }
-    }
-
-    free(ctx_ptr);
+    pthread_mutex_unlock(&mtx_ctxsw);
+    free(ctx->name);
+    free(ctx);
     pthread_exit(0);
 }
 
@@ -300,155 +289,169 @@ empth_terminate(empth_t *a)
     pthread_kill(a->id, SIGALRM);
 }
 
-void
-empth_select(int fd, int flags)
+int
+empth_select(int fd, int flags, struct timeval *tv)
 {
-
     fd_set readmask;
     fd_set writemask;
-    struct timeval tv;
     int n;
+    int res = 0;
 
     pthread_mutex_unlock(&mtx_ctxsw);
     empth_status("%s select on %d",
                 flags == EMPTH_FD_READ ? "read" : "write", fd);
-    while (1) {
-       tv.tv_sec = 1000000;
-       tv.tv_usec = 0;
 
-       FD_ZERO(&readmask);
-       FD_ZERO(&writemask);
-
-       switch (flags) {
-       case EMPTH_FD_READ:
-           FD_SET(fd, &readmask);
-           break;
-       case EMPTH_FD_WRITE:
-           FD_SET(fd, &writemask);
-           break;
-       default:
-           logerror("bad flag %d passed to empth_select", flags);
-           empth_exit();
-       }
+    FD_ZERO(&readmask);
+    FD_ZERO(&writemask);
+
+    switch (flags) {
+    case EMPTH_FD_READ:
+       FD_SET(fd, &readmask);
+       break;
+    case EMPTH_FD_WRITE:
+       FD_SET(fd, &writemask);
+       break;
+    default:
+       CANT_REACH();
+       errno = EINVAL;
+       res = -1;
+       goto done;
+    }
 
-       n = select(fd + 1, &readmask, &writemask, (fd_set *) 0, &tv);
+    n = select(fd + 1, &readmask, &writemask, (fd_set *) 0, tv);
 
-       if (n < 0) {
-           if (errno == EINTR) {
-               /* go handle the signal */
-               empth_status("select broken by signal");
-               goto done;
-               return;
-           }
-           /* strange but we dont get EINTR on select broken by signal */
+    if (n < 0) {
+       if (errno == EINTR) /* go handle the signal */
+           empth_status("select broken by signal");
+        else
            empth_status("select failed (%s)", strerror(errno));
-           goto done;
-           return;
-       }
-
-       if (flags == EMPTH_FD_READ && FD_ISSET(fd, &readmask)) {
-           empth_status("input ready");
-           break;
-       }
-       if (flags == EMPTH_FD_WRITE && FD_ISSET(fd, &writemask)) {
-           empth_status("output ready");
-           break;
-       }
+       res = -1;
+    } else if (n == 0) {
+       empth_status("select timed out");
+       res = 0;
+    } else if (flags == EMPTH_FD_READ && FD_ISSET(fd, &readmask)) {
+       empth_status("input ready");
+       res = 1;
+    } else if (flags == EMPTH_FD_WRITE && FD_ISSET(fd, &writemask)) {
+       empth_status("output ready");
+       res = 1;
     }
 
-  done:
+done:
     pthread_mutex_lock(&mtx_ctxsw);
     empth_restorectx();
-
+    return res;
 }
 
-
 static void
 empth_alarm(int sig)
 {
-    struct sigaction act;
-    empth_status("got alarm signal");
-#ifdef SA_RESTART
-    act.sa_flags &= ~SA_RESTART;
-#endif
-    sigemptyset(&act.sa_mask);
-    act.sa_handler = empth_alarm;
-    sigaction(SIGALRM, &act, NULL);
+    /*
+     * Nothing to do --- we handle this signal just to let
+     * empth_wakeup() and empth_terminate() interrupt system calls.
+     */
 }
 
 void
 empth_wakeup(empth_t *a)
 {
     empth_status("waking up thread %s", a->name);
+    if (a->state == 0)
+       a->state = EMPTH_INTR;
     pthread_kill(a->id, SIGALRM);
-    empth_status("waiting for it to run");
 }
 
-void
+int
 empth_sleep(time_t until)
 {
+    empth_t *ctx = pthread_getspecific(ctx_key);
     struct timeval tv;
+    int res;
 
     empth_status("going to sleep %ld sec", until - time(0));
     pthread_mutex_unlock(&mtx_ctxsw);
-    tv.tv_sec = until - time(NULL);
-    tv.tv_usec = 0;
     do {
-       select(0, NULL, NULL, NULL, &tv);
-    } while ((tv.tv_sec = until - time(NULL)) > 0);
+       tv.tv_sec = until - time(NULL);
+       tv.tv_usec = 0;
+       res = select(0, NULL, NULL, NULL, &tv);
+    } while (res < 0 && ctx->state == 0);
     empth_status("sleep done. Waiting for lock");
     pthread_mutex_lock(&mtx_ctxsw);
     empth_restorectx();
+    return res;
 }
 
+int
+empth_wait_for_signal(void)
+{
+    sigset_t set;
+    int sig, err;
 
-empth_sem_t *
-empth_sem_create(char *name, int cnt)
+    sigemptyset(&set);
+    sigaddset(&set, SIGHUP);
+    sigaddset(&set, SIGINT);
+    sigaddset(&set, SIGTERM);
+    pthread_mutex_unlock(&mtx_ctxsw);
+    for (;;) {
+       empth_status("waiting for signals");
+       err = sigwait(&set, &sig);
+       if (CANT_HAPPEN(err)) {
+           sleep(60);
+           continue;
+       }
+       empth_status("got awaited signal %d", sig);
+       pthread_mutex_lock(&mtx_ctxsw);
+       empth_restorectx();
+       return sig;
+    }
+}
+
+empth_rwlock_t *
+empth_rwlock_create(char *name)
 {
-    empth_sem_t *sm;
+    empth_rwlock_t *rwlock;
+
+    rwlock = malloc(sizeof(*rwlock));
+    if (!rwlock)
+       return NULL;
 
-    sm = malloc(sizeof(empth_sem_t));
-    if (!sm) {
-       logerror("out of memory at %s:%d", __FILE__, __LINE__);
+    if (pthread_rwlock_init(&rwlock->lock, NULL) != 0) {
+       free(rwlock);
        return NULL;
     }
-    strncpy(sm->name, name, sizeof(sm->name) - 1);
-    sm->count = cnt;
-    pthread_mutex_init(&sm->mtx_update, NULL);
-    pthread_mutex_init(&sm->mtx_sem, NULL);
-    pthread_cond_init(&sm->cnd_sem, NULL);
-    return sm;
+
+    rwlock->name = strdup(name);
+    return rwlock;
 }
 
 void
-empth_sem_signal(empth_sem_t *sm)
+empth_rwlock_destroy(empth_rwlock_t *rwlock)
 {
-    empth_status("signal on semaphore %s:%d", sm->name, sm->count);
-    pthread_mutex_lock(&sm->mtx_update);
-    if (sm->count++ < 0) {
-       pthread_mutex_unlock(&sm->mtx_update);
-       pthread_mutex_lock(&sm->mtx_sem);
-       pthread_cond_signal(&sm->cnd_sem);
-       pthread_mutex_unlock(&sm->mtx_sem);
-    } else
-       pthread_mutex_unlock(&sm->mtx_update);
+    pthread_rwlock_destroy(&rwlock->lock);
+    free(rwlock->name);
+    free(rwlock);
 }
 
 void
-empth_sem_wait(empth_sem_t *sm)
+empth_rwlock_wrlock(empth_rwlock_t *rwlock)
 {
-    empth_status("wait on semaphore %s:%d", sm->name, sm->count);
-    pthread_mutex_lock(&sm->mtx_update);
-    if (--sm->count < 0) {
-       pthread_mutex_unlock(&sm->mtx_update);
-       empth_status("blocking");
-       pthread_mutex_unlock(&mtx_ctxsw);
-       pthread_mutex_lock(&sm->mtx_sem);
-       pthread_cond_wait(&sm->cnd_sem, &sm->mtx_sem);
-       empth_status("waking up");
-       pthread_mutex_unlock(&sm->mtx_sem);
-       pthread_mutex_lock(&mtx_ctxsw);
-       empth_restorectx();
-    } else
-       pthread_mutex_unlock(&sm->mtx_update);
+    pthread_mutex_unlock(&mtx_ctxsw);
+    pthread_rwlock_wrlock(&rwlock->lock);
+    pthread_mutex_lock(&mtx_ctxsw);
+    empth_restorectx();
+}
+
+void
+empth_rwlock_rdlock(empth_rwlock_t *rwlock)
+{
+    pthread_mutex_unlock(&mtx_ctxsw);
+    pthread_rwlock_rdlock(&rwlock->lock);
+    pthread_mutex_lock(&mtx_ctxsw);
+    empth_restorectx();
+}
+
+void
+empth_rwlock_unlock(empth_rwlock_t *rwlock)
+{
+    pthread_rwlock_unlock(&rwlock->lock);
 }