/*
* Empire - A multi-player, client/server Internet based war game.
- * Copyright (C) 1986-2006, Dave Pare, Jeff Bailey, Thomas Ruschak,
- * Ken Stevens, Steve McClure
+ * Copyright (C) 1986-2020, 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/>.
*
* ---
*
* ---
*
* pthread.c: Interface from Empire threads to POSIX threads
- *
+ *
* Known contributors to this file:
* Sasha Mikheev
* Steve McClure, 1998
- * Markus Armbruster, 2005
+ * Markus Armbruster, 2005-2012
+ * Ron Koenderink, 2007-2009
*/
#include <config.h>
-#include <stdio.h>
-#if !defined(_WIN32)
-#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 <pthread.h>
+#include <signal.h>
+#include <stdarg.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <sys/select.h>
+#include <unistd.h>
#include "misc.h"
#include "empthread.h"
+#include "file.h"
#include "prototypes.h"
-#include <stdarg.h>
-
-#define EMPTH_KILLED 1
-
struct empth_t {
char *name; /* thread name */
- char *desc; /* description */
void *ud; /* user data */
- int state; /* my state */
+ int wakeup;
void (*ep)(void *); /* entry point */
- pthread_t id; /* thread id */
+ 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 {
+ /* Can't use pthread_rwlock_t, because it needn't prefer writers */
+ char *name;
+ int nread; /* #active readers */
+ int nwrite; /* total #writers (active and waiting) */
+ pthread_cond_t can_read;
+ pthread_cond_t can_write;
};
/* Thread-specific data key */
*/
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);
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;
+ ctx->wakeup = 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);
+ ef_make_stale();
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->wakeup = 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)
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_status("new thread ID is %ld", (long)t);
+ empth_yield();
return ctx;
bad:
ctx_ptr = pthread_getspecific(ctx_key);
*udata = ctx_ptr->ud;
- if (ctx_ptr->state == EMPTH_KILLED) {
- empth_status("i am dead");
- empth_exit();
- }
+ ctx_ptr->wakeup = 0;
empth_status("context restored");
}
empth_t *
empth_self(void)
{
- return pthread_getspecific(ctx_key);
+ return udata ? pthread_getspecific(ctx_key) : NULL;
+}
+
+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);
+ ef_make_stale();
+ pthread_mutex_unlock(&mtx_ctxsw);
+ free(ctx->name);
+ free(ctx);
pthread_exit(0);
}
void
empth_yield(void)
{
+ ef_make_stale();
pthread_mutex_unlock(&mtx_ctxsw);
pthread_mutex_lock(&mtx_ctxsw);
empth_restorectx();
}
-void
-empth_terminate(empth_t *a)
-{
- empth_status("killing thread %s", a->name);
- a->state = EMPTH_KILLED;
- pthread_kill(a->id, SIGALRM);
-}
-
-void
-empth_select(int fd, int flags)
+int
+empth_select(int fd, int flags, struct timeval *timeout)
{
-
fd_set readmask;
fd_set writemask;
struct timeval tv;
int n;
+ empth_t *ctx;
+ 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();
- }
-
- n = select(fd + 1, &readmask, &writemask, (fd_set *) 0, &tv);
+ if (CANT_HAPPEN(fd < 0 || fd >= FD_SETSIZE)) {
+ errno = EBADF;
+ return -1;
+ }
- 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 */
+ ef_make_stale();
+ pthread_mutex_unlock(&mtx_ctxsw);
+ empth_status("select on %d for %d", fd, flags);
+
+again:
+ FD_ZERO(&readmask);
+ FD_ZERO(&writemask);
+ if (flags & EMPTH_FD_READ)
+ FD_SET(fd, &readmask);
+ if (flags & EMPTH_FD_WRITE)
+ FD_SET(fd, &writemask);
+
+ if (timeout)
+ tv = *timeout;
+ n = select(fd + 1, &readmask, &writemask, NULL, timeout ? &tv : NULL);
+ if (n < 0) {
+ ctx = pthread_getspecific(ctx_key);
+ if (ctx->wakeup) {
+ empth_status("select woken up");
+ res = 0;
+ } else if (errno == EINTR) {
+ empth_status("select broken by signal");
+ goto again;
+ } 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:
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() interrupt system calls.
+ */
}
void
empth_wakeup(empth_t *a)
{
empth_status("waking up thread %s", a->name);
+ a->wakeup = 1;
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);
+ time_t now;
struct timeval tv;
+ int res;
- empth_status("going to sleep %ld sec", until - time(0));
+ ef_make_stale();
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);
+ now = time(NULL);
+ tv.tv_sec = until >= now ? until - now : 0;
+ tv.tv_usec = 0;
+ empth_status("going to sleep %ld sec", (long)tv.tv_sec);
+ res = select(0, NULL, NULL, NULL, &tv);
+ } while (res < 0 && !ctx->wakeup);
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;
+
+ ef_make_stale();
+ 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_sem_t *
-empth_sem_create(char *name, int cnt)
+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_cond_init(&rwlock->can_read, NULL) != 0
+ || pthread_cond_init(&rwlock->can_write, 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);
+ rwlock->nread = rwlock->nwrite = 0;
+ 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_cond_destroy(&rwlock->can_read);
+ pthread_cond_destroy(&rwlock->can_write);
+ 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_status("wrlock %s %d %d",
+ rwlock->name, rwlock->nread, rwlock->nwrite);
+ ef_make_stale();
+ rwlock->nwrite++;
+ while (rwlock->nread != 0 || rwlock->nwrite != 1) {
+ empth_status("waiting for wrlock %s", rwlock->name);
+ pthread_cond_wait(&rwlock->can_write, &mtx_ctxsw);
+ empth_status("got wrlock %s %d %d",
+ rwlock->name, rwlock->nread, rwlock->nwrite);
empth_restorectx();
- } else
- pthread_mutex_unlock(&sm->mtx_update);
+ }
+}
+
+void
+empth_rwlock_rdlock(empth_rwlock_t *rwlock)
+{
+ empth_status("rdlock %s %d %d",
+ rwlock->name, rwlock->nread, rwlock->nwrite);
+ ef_make_stale();
+ while (rwlock->nwrite) {
+ empth_status("waiting for rdlock %s", rwlock->name);
+ pthread_cond_wait(&rwlock->can_read, &mtx_ctxsw);
+ empth_status("got rdlock %s %d %d",
+ rwlock->name, rwlock->nread, rwlock->nwrite);
+ empth_restorectx();
+ }
+ rwlock->nread++;
+}
+
+void
+empth_rwlock_unlock(empth_rwlock_t *rwlock)
+{
+ if (CANT_HAPPEN(!rwlock->nread && !rwlock->nwrite))
+ return;
+ if (rwlock->nread) { /* holding read lock */
+ if (!--rwlock->nread)
+ pthread_cond_signal(&rwlock->can_write);
+ } else {
+ rwlock->nwrite--;
+ pthread_cond_signal(&rwlock->can_write);
+ }
+ if (rwlock->nwrite == 0)
+ pthread_cond_broadcast(&rwlock->can_read);
}