git.pond.sub.org Git - empserver/blob - src/lib/empthread/pthread.c

   1 /*
   2  *  Empire - A multi-player, client/server Internet based war game.
   3  *  Copyright (C) 1986-2006, Dave Pare, Jeff Bailey, Thomas Ruschak,
   4  *                           Ken Stevens, Steve McClure
   5  *
   6  *  This program is free software; you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation; either version 2 of the License, or
   9  *  (at your option) any later version.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with this program; if not, write to the Free Software
  18  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  *  ---
  21  *
  22  *  See files README, COPYING and CREDITS in the root of the source
  23  *  tree for related information and legal notices.  It is expected
  24  *  that future projects/authors will amend these files as needed.
  25  *
  26  *  ---
  27  *
  28  *  pthread.c: Interface from Empire threads to POSIX threads
  29  *
  30  *  Known contributors to this file:
  31  *     Sasha Mikheev
  32  *     Steve McClure, 1998
  33  *     Markus Armbruster, 2005
  34  */
  35
  36 /* Required for PTHREAD_STACK_MIN on some systems, e.g. Solaris: */
  37 #define _XOPEN_SOURCE 500
  38
  39 #include <config.h>
  40
  41 #include <stdio.h>
  42 #if !defined(_WIN32)
  43 #include <sys/time.h>
  44 #include <unistd.h>
  45 #endif
  46 #include <sys/types.h>
  47 #include <signal.h>
  48 #include <errno.h>
  49 #include <string.h>
  50 #include <limits.h>
  51
  52 #include "misc.h"
  53 #include "empthread.h"
  54 #include "prototypes.h"
  55
  56 #include <stdarg.h>
  57
  58 #define EMPTH_KILLED  1
  59
  60 struct empth_t {
  61     char *name;                 /* thread name */
  62     char *desc;                 /* description */
  63     void *ud;                   /* user data */
  64     int state;                  /* my state */
  65     void (*ep)(void *);         /* entry point */
  66     pthread_t id;               /* thread id */
  67 };
  68
  69 struct empth_sem_t {
  70     pthread_mutex_t mtx_update; /* use it to update count */
  71     int count;
  72     char name[80];
  73     pthread_mutex_t mtx_sem;
  74     pthread_cond_t cnd_sem;
  75 };
  76
  77 /* Thread-specific data key */
  78 static pthread_key_t ctx_key;
  79
  80 /* Flags that were passed to empth_init() */
  81 static int empth_flags;
  82
  83 /* Pointer to thread context variable */
  84 static void **udata;
  85
  86 /*
  87  * Non-preemption mutex.
  88  * Empire code outside this file is only executed while holding this
  89  * mutex.  This makes sure Empire code is never preempted by Empire
  90  * code.
  91  */
  92 static pthread_mutex_t mtx_ctxsw;
  93
  94 static void empth_status(char *format, ...)
  95     ATTRIBUTE((format (printf, 1, 2)));
  96 static void empth_alarm(int sig);
  97
  98 static void *
  99 empth_start(void *arg)
 100 {
 101     empth_t *ctx = arg;
 102
 103     ctx->id = pthread_self();
 104     pthread_setspecific(ctx_key, ctx);
 105     pthread_mutex_lock(&mtx_ctxsw);
 106     *udata = ctx->ud;
 107     ctx->ep(ctx->ud);
 108     empth_exit();
 109     return NULL;
 110 }
 111
 112 static void
 113 empth_status(char *format, ...)
 114 {
 115     va_list ap;
 116     static struct timeval startTime;
 117     struct timeval tv;
 118     char buf[1024];
 119     int sec, msec;
 120     empth_t *a;
 121
 122     va_start(ap, format);
 123     if (empth_flags & EMPTH_PRINT) {
 124         if (startTime.tv_sec == 0)
 125             gettimeofday(&startTime, 0);
 126         gettimeofday(&tv, 0);
 127         sec = tv.tv_sec - startTime.tv_sec;
 128         msec = (tv.tv_usec - startTime.tv_usec) / 1000;
 129         if (msec < 0) {
 130             sec++;
 131             msec += 1000;
 132         }
 133         vsprintf(buf, format, ap);
 134         a = empth_self();
 135         printf("%d:%02d.%03d %17s: %s\n", sec / 60, sec % 60, msec / 10,
 136                a->name, buf);
 137
 138     }
 139     va_end(ap);
 140 }
 141
 142
 143 int
 144 empth_init(void **ctx_ptr, int flags)
 145 {
 146     empth_t *ctx;
 147     sigset_t set;
 148     struct sigaction act;
 149
 150     empth_flags = flags;
 151     udata = ctx_ptr;
 152
 153     empth_init_signals();
 154     sigemptyset(&set);
 155     sigaddset(&set, SIGINT);
 156     sigaddset(&set, SIGTERM);
 157     pthread_sigmask(SIG_BLOCK, &set, NULL);
 158     act.sa_flags = 0;
 159     sigemptyset(&act.sa_mask);
 160     act.sa_handler = empth_alarm;
 161     sigaction(SIGALRM, &act, NULL);
 162
 163     pthread_key_create(&ctx_key, NULL);
 164     pthread_mutex_init(&mtx_ctxsw, NULL);
 165
 166     ctx = malloc(sizeof(empth_t));
 167     if (!ctx) {
 168         logerror("pthread init failed: not enough memory");
 169         exit(1);
 170     }
 171     ctx->name = "Main";
 172     ctx->desc = "empire main";
 173     ctx->ep = 0;
 174     ctx->ud = 0;
 175     ctx->id = pthread_self();
 176     ctx->state = 0;
 177     pthread_setspecific(ctx_key, ctx);
 178     pthread_mutex_lock(&mtx_ctxsw);
 179     logerror("pthreads initialized");
 180     return 0;
 181 }
 182
 183
 184 /*
 185  * prio can be used for setting scheeduling policy but...
 186  * it seems to be optional in POSIX threads and Solaris
 187  * for example just ignores it.
 188  * More then that priority is not needed even in lwp threads.
 189  */
 190 empth_t *
 191 empth_create(int prio, void (*entry)(void *), int size, int flags,
 192              char *name, char *desc, void *ud)
 193 {
 194     pthread_t t;
 195     pthread_attr_t attr;
 196     empth_t *ctx;
 197     int eno;
 198
 199     empth_status("creating new thread %s:%s", name, desc);
 200
 201     ctx = malloc(sizeof(empth_t));
 202     if (!ctx) {
 203         logerror("not enough memory to create thread: %s (%s)",
 204                  name, desc);
 205         return NULL;
 206     }
 207     ctx->name = strdup(name);
 208     ctx->desc = strdup(desc);
 209     ctx->ud = ud;
 210     ctx->state = 0;
 211     ctx->ep = entry;
 212
 213     eno = pthread_attr_init(&attr);
 214     if (eno) {
 215         logerror("can not create thread attribute %s (%s): %s",
 216                  name, desc, strerror(eno));
 217         goto bad;
 218     }
 219     if (size < PTHREAD_STACK_MIN)
 220         size = PTHREAD_STACK_MIN;
 221     pthread_attr_setstacksize(&attr, size);
 222     pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
 223
 224     eno = pthread_create(&t, &attr, empth_start, ctx);
 225     if (eno) {
 226         logerror("can not create thread: %s (%s): %s",
 227                  name, desc, strerror(eno));
 228         goto bad;
 229     }
 230     empth_status("new thread id is %ld", (long)t);
 231     empth_yield();
 232     return ctx;
 233
 234   bad:
 235     pthread_attr_destroy(&attr);
 236     free(ctx);
 237     return NULL;
 238 }
 239
 240
 241 static void
 242 empth_restorectx(void)
 243 {
 244     empth_t *ctx_ptr;
 245
 246     ctx_ptr = pthread_getspecific(ctx_key);
 247     *udata = ctx_ptr->ud;
 248     if (ctx_ptr->state == EMPTH_KILLED) {
 249         empth_status("i am dead");
 250         empth_exit();
 251     }
 252     empth_status("context restored");
 253 }
 254
 255 empth_t *
 256 empth_self(void)
 257 {
 258     return pthread_getspecific(ctx_key);
 259 }
 260
 261 void
 262 empth_exit(void)
 263 {
 264     empth_status("empth_exit");
 265     pthread_mutex_unlock(&mtx_ctxsw);
 266     free(pthread_getspecific(ctx_key));
 267     pthread_exit(0);
 268 }
 269
 270 void
 271 empth_yield(void)
 272 {
 273     pthread_mutex_unlock(&mtx_ctxsw);
 274     pthread_mutex_lock(&mtx_ctxsw);
 275     empth_restorectx();
 276 }
 277
 278 void
 279 empth_terminate(empth_t *a)
 280 {
 281     empth_status("killing thread %s", a->name);
 282     a->state = EMPTH_KILLED;
 283     pthread_kill(a->id, SIGALRM);
 284 }
 285
 286 void
 287 empth_select(int fd, int flags)
 288 {
 289
 290     fd_set readmask;
 291     fd_set writemask;
 292     struct timeval tv;
 293     int n;
 294
 295     pthread_mutex_unlock(&mtx_ctxsw);
 296     empth_status("%s select on %d",
 297                  flags == EMPTH_FD_READ ? "read" : "write", fd);
 298     while (1) {
 299         tv.tv_sec = 1000000;
 300         tv.tv_usec = 0;
 301
 302         FD_ZERO(&readmask);
 303         FD_ZERO(&writemask);
 304
 305         switch (flags) {
 306         case EMPTH_FD_READ:
 307             FD_SET(fd, &readmask);
 308             break;
 309         case EMPTH_FD_WRITE:
 310             FD_SET(fd, &writemask);
 311             break;
 312         default:
 313             logerror("bad flag %d passed to empth_select", flags);
 314             empth_exit();
 315         }
 316
 317         n = select(fd + 1, &readmask, &writemask, (fd_set *) 0, &tv);
 318
 319         if (n < 0) {
 320             if (errno == EINTR) {
 321                 /* go handle the signal */
 322                 empth_status("select broken by signal");
 323                 goto done;
 324                 return;
 325             }
 326             /* strange but we dont get EINTR on select broken by signal */
 327             empth_status("select failed (%s)", strerror(errno));
 328             goto done;
 329             return;
 330         }
 331
 332         if (flags == EMPTH_FD_READ && FD_ISSET(fd, &readmask)) {
 333             empth_status("input ready");
 334             break;
 335         }
 336         if (flags == EMPTH_FD_WRITE && FD_ISSET(fd, &writemask)) {
 337             empth_status("output ready");
 338             break;
 339         }
 340     }
 341
 342   done:
 343     pthread_mutex_lock(&mtx_ctxsw);
 344     empth_restorectx();
 345
 346 }
 347
 348 static void
 349 empth_alarm(int sig)
 350 {
 351     /*
 352      * Nothing to do --- we handle this signal just to let
 353      * empth_wakeup() interrupt system calls.
 354      */
 355     empth_status("got alarm signal");
 356 }
 357
 358 void
 359 empth_wakeup(empth_t *a)
 360 {
 361     empth_status("waking up thread %s", a->name);
 362     pthread_kill(a->id, SIGALRM);
 363 }
 364
 365 void
 366 empth_sleep(time_t until)
 367 {
 368     struct timeval tv;
 369
 370     empth_status("going to sleep %ld sec", until - time(0));
 371     pthread_mutex_unlock(&mtx_ctxsw);
 372     tv.tv_sec = until - time(NULL);
 373     tv.tv_usec = 0;
 374     do {
 375         select(0, NULL, NULL, NULL, &tv);
 376     } while ((tv.tv_sec = until - time(NULL)) > 0);
 377     empth_status("sleep done. Waiting for lock");
 378     pthread_mutex_lock(&mtx_ctxsw);
 379     empth_restorectx();
 380 }
 381
 382 int
 383 empth_wait_for_shutdown(void)
 384 {
 385     sigset_t set;
 386     int sig, err;
 387
 388     sigemptyset(&set);
 389     sigaddset(&set, SIGINT);
 390     sigaddset(&set, SIGTERM);
 391     for (;;) {
 392         empth_status("waiting for signals");
 393         err = sigwait(&set, &sig);
 394         if (CANT_HAPPEN(err)) {
 395             sleep(60);
 396             continue;
 397         }
 398         empth_status("got awaited signal %d", sig);
 399         return sig;
 400     }
 401 }
 402
 403 empth_sem_t *
 404 empth_sem_create(char *name, int cnt)
 405 {
 406     empth_sem_t *sm;
 407
 408     sm = malloc(sizeof(empth_sem_t));
 409     if (!sm) {
 410         logerror("out of memory at %s:%d", __FILE__, __LINE__);
 411         return NULL;
 412     }
 413     strncpy(sm->name, name, sizeof(sm->name) - 1);
 414     sm->count = cnt;
 415     pthread_mutex_init(&sm->mtx_update, NULL);
 416     pthread_mutex_init(&sm->mtx_sem, NULL);
 417     pthread_cond_init(&sm->cnd_sem, NULL);
 418     return sm;
 419 }
 420
 421 void
 422 empth_sem_signal(empth_sem_t *sm)
 423 {
 424     empth_status("signal on semaphore %s:%d", sm->name, sm->count);
 425     pthread_mutex_lock(&sm->mtx_update);
 426     if (sm->count++ < 0) {
 427         pthread_mutex_unlock(&sm->mtx_update);
 428         pthread_mutex_lock(&sm->mtx_sem);
 429         pthread_cond_signal(&sm->cnd_sem);
 430         pthread_mutex_unlock(&sm->mtx_sem);
 431     } else
 432         pthread_mutex_unlock(&sm->mtx_update);
 433 }
 434
 435 void
 436 empth_sem_wait(empth_sem_t *sm)
 437 {
 438     empth_status("wait on semaphore %s:%d", sm->name, sm->count);
 439     pthread_mutex_lock(&sm->mtx_update);
 440     if (--sm->count < 0) {
 441         pthread_mutex_unlock(&sm->mtx_update);
 442         empth_status("blocking");
 443         pthread_mutex_unlock(&mtx_ctxsw);
 444         pthread_mutex_lock(&sm->mtx_sem);
 445         pthread_cond_wait(&sm->cnd_sem, &sm->mtx_sem);
 446         empth_status("waking up");
 447         pthread_mutex_unlock(&sm->mtx_sem);
 448         pthread_mutex_lock(&mtx_ctxsw);
 449         empth_restorectx();
 450     } else
 451         pthread_mutex_unlock(&sm->mtx_update);
 452 }