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     struct sigaction act;
 148
 149     empth_flags = flags;
 150     udata = ctx_ptr;
 151
 152     empth_init_signals();
 153     act.sa_flags = 0;
 154     sigemptyset(&act.sa_mask);
 155     act.sa_handler = empth_alarm;
 156     sigaction(SIGALRM, &act, NULL);
 157
 158     pthread_key_create(&ctx_key, NULL);
 159     pthread_mutex_init(&mtx_ctxsw, NULL);
 160
 161     ctx = malloc(sizeof(empth_t));
 162     if (!ctx) {
 163         logerror("pthread init failed: not enough memory");
 164         exit(1);
 165     }
 166     ctx->name = "Main";
 167     ctx->desc = "empire main";
 168     ctx->ep = 0;
 169     ctx->ud = 0;
 170     ctx->id = pthread_self();
 171     ctx->state = 0;
 172     pthread_setspecific(ctx_key, ctx);
 173     pthread_mutex_lock(&mtx_ctxsw);
 174     logerror("pthreads initialized");
 175     return 0;
 176 }
 177
 178
 179 /*
 180  * prio can be used for setting scheeduling policy but...
 181  * it seems to be optional in POSIX threads and Solaris
 182  * for example just ignores it.
 183  * More then that priority is not needed even in lwp threads.
 184  */
 185 empth_t *
 186 empth_create(int prio, void (*entry)(void *), int size, int flags,
 187              char *name, char *desc, void *ud)
 188 {
 189     pthread_t t;
 190     pthread_attr_t attr;
 191     empth_t *ctx;
 192     int eno;
 193
 194     empth_status("creating new thread %s:%s", name, desc);
 195
 196     ctx = malloc(sizeof(empth_t));
 197     if (!ctx) {
 198         logerror("not enough memory to create thread: %s (%s)",
 199                  name, desc);
 200         return NULL;
 201     }
 202     ctx->name = strdup(name);
 203     ctx->desc = strdup(desc);
 204     ctx->ud = ud;
 205     ctx->state = 0;
 206     ctx->ep = entry;
 207
 208     eno = pthread_attr_init(&attr);
 209     if (eno) {
 210         logerror("can not create thread attribute %s (%s): %s",
 211                  name, desc, strerror(eno));
 212         goto bad;
 213     }
 214     if (size < PTHREAD_STACK_MIN)
 215         size = PTHREAD_STACK_MIN;
 216     pthread_attr_setstacksize(&attr, size);
 217     pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
 218
 219     eno = pthread_create(&t, &attr, empth_start, ctx);
 220     if (eno) {
 221         logerror("can not create thread: %s (%s): %s",
 222                  name, desc, strerror(eno));
 223         goto bad;
 224     }
 225     empth_status("new thread id is %ld", (long)t);
 226     empth_yield();
 227     return ctx;
 228
 229   bad:
 230     pthread_attr_destroy(&attr);
 231     free(ctx);
 232     return NULL;
 233 }
 234
 235
 236 static void
 237 empth_restorectx(void)
 238 {
 239     empth_t *ctx_ptr;
 240
 241     ctx_ptr = pthread_getspecific(ctx_key);
 242     *udata = ctx_ptr->ud;
 243     if (ctx_ptr->state == EMPTH_KILLED) {
 244         empth_status("i am dead");
 245         empth_exit();
 246     }
 247     empth_status("context restored");
 248 }
 249
 250 empth_t *
 251 empth_self(void)
 252 {
 253     return pthread_getspecific(ctx_key);
 254 }
 255
 256 void
 257 empth_exit(void)
 258 {
 259     empth_t *ctx_ptr;
 260
 261     pthread_mutex_unlock(&mtx_ctxsw);
 262     empth_status("empth_exit");
 263     ctx_ptr = pthread_getspecific(ctx_key);
 264     /* We want to leave the main thread around forever, until it's time
 265        for it to die for real (in a shutdown) */
 266     if (!strcmp(ctx_ptr->name, "Main")) {
 267         while (1) {
 268             sleep(60);
 269         }
 270     }
 271
 272     free(ctx_ptr);
 273     pthread_exit(0);
 274 }
 275
 276 void
 277 empth_yield(void)
 278 {
 279     pthread_mutex_unlock(&mtx_ctxsw);
 280     pthread_mutex_lock(&mtx_ctxsw);
 281     empth_restorectx();
 282 }
 283
 284 void
 285 empth_terminate(empth_t *a)
 286 {
 287     empth_status("killing thread %s", a->name);
 288     a->state = EMPTH_KILLED;
 289     pthread_kill(a->id, SIGALRM);
 290 }
 291
 292 void
 293 empth_select(int fd, int flags)
 294 {
 295
 296     fd_set readmask;
 297     fd_set writemask;
 298     struct timeval tv;
 299     int n;
 300
 301     pthread_mutex_unlock(&mtx_ctxsw);
 302     empth_status("%s select on %d",
 303                  flags == EMPTH_FD_READ ? "read" : "write", fd);
 304     while (1) {
 305         tv.tv_sec = 1000000;
 306         tv.tv_usec = 0;
 307
 308         FD_ZERO(&readmask);
 309         FD_ZERO(&writemask);
 310
 311         switch (flags) {
 312         case EMPTH_FD_READ:
 313             FD_SET(fd, &readmask);
 314             break;
 315         case EMPTH_FD_WRITE:
 316             FD_SET(fd, &writemask);
 317             break;
 318         default:
 319             logerror("bad flag %d passed to empth_select", flags);
 320             empth_exit();
 321         }
 322
 323         n = select(fd + 1, &readmask, &writemask, (fd_set *) 0, &tv);
 324
 325         if (n < 0) {
 326             if (errno == EINTR) {
 327                 /* go handle the signal */
 328                 empth_status("select broken by signal");
 329                 goto done;
 330                 return;
 331             }
 332             /* strange but we dont get EINTR on select broken by signal */
 333             empth_status("select failed (%s)", strerror(errno));
 334             goto done;
 335             return;
 336         }
 337
 338         if (flags == EMPTH_FD_READ && FD_ISSET(fd, &readmask)) {
 339             empth_status("input ready");
 340             break;
 341         }
 342         if (flags == EMPTH_FD_WRITE && FD_ISSET(fd, &writemask)) {
 343             empth_status("output ready");
 344             break;
 345         }
 346     }
 347
 348   done:
 349     pthread_mutex_lock(&mtx_ctxsw);
 350     empth_restorectx();
 351
 352 }
 353
 354
 355 static void
 356 empth_alarm(int sig)
 357 {
 358     /*
 359      * Nothing to do --- we handle this signal just to let
 360      * empth_wakeup() interrupt system calls.
 361      */
 362     empth_status("got alarm signal");
 363 }
 364
 365 void
 366 empth_wakeup(empth_t *a)
 367 {
 368     empth_status("waking up thread %s", a->name);
 369     pthread_kill(a->id, SIGALRM);
 370 }
 371
 372 void
 373 empth_sleep(time_t until)
 374 {
 375     struct timeval tv;
 376
 377     empth_status("going to sleep %ld sec", until - time(0));
 378     pthread_mutex_unlock(&mtx_ctxsw);
 379     tv.tv_sec = until - time(NULL);
 380     tv.tv_usec = 0;
 381     do {
 382         select(0, NULL, NULL, NULL, &tv);
 383     } while ((tv.tv_sec = until - time(NULL)) > 0);
 384     empth_status("sleep done. Waiting for lock");
 385     pthread_mutex_lock(&mtx_ctxsw);
 386     empth_restorectx();
 387 }
 388
 389
 390 empth_sem_t *
 391 empth_sem_create(char *name, int cnt)
 392 {
 393     empth_sem_t *sm;
 394
 395     sm = malloc(sizeof(empth_sem_t));
 396     if (!sm) {
 397         logerror("out of memory at %s:%d", __FILE__, __LINE__);
 398         return NULL;
 399     }
 400     strncpy(sm->name, name, sizeof(sm->name) - 1);
 401     sm->count = cnt;
 402     pthread_mutex_init(&sm->mtx_update, NULL);
 403     pthread_mutex_init(&sm->mtx_sem, NULL);
 404     pthread_cond_init(&sm->cnd_sem, NULL);
 405     return sm;
 406 }
 407
 408 void
 409 empth_sem_signal(empth_sem_t *sm)
 410 {
 411     empth_status("signal on semaphore %s:%d", sm->name, sm->count);
 412     pthread_mutex_lock(&sm->mtx_update);
 413     if (sm->count++ < 0) {
 414         pthread_mutex_unlock(&sm->mtx_update);
 415         pthread_mutex_lock(&sm->mtx_sem);
 416         pthread_cond_signal(&sm->cnd_sem);
 417         pthread_mutex_unlock(&sm->mtx_sem);
 418     } else
 419         pthread_mutex_unlock(&sm->mtx_update);
 420 }
 421
 422 void
 423 empth_sem_wait(empth_sem_t *sm)
 424 {
 425     empth_status("wait on semaphore %s:%d", sm->name, sm->count);
 426     pthread_mutex_lock(&sm->mtx_update);
 427     if (--sm->count < 0) {
 428         pthread_mutex_unlock(&sm->mtx_update);
 429         empth_status("blocking");
 430         pthread_mutex_unlock(&mtx_ctxsw);
 431         pthread_mutex_lock(&sm->mtx_sem);
 432         pthread_cond_wait(&sm->cnd_sem, &sm->mtx_sem);
 433         empth_status("waking up");
 434         pthread_mutex_unlock(&sm->mtx_sem);
 435         pthread_mutex_lock(&mtx_ctxsw);
 436         empth_restorectx();
 437     } else
 438         pthread_mutex_unlock(&sm->mtx_update);
 439 }