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

   1 /*
   2  *  Empire - A multi-player, client/server Internet based war game.
   3  *  Copyright (C) 1986-2007, 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  *  ntthread.c: Interface from Empire threads to Windows NT threads
  29  *
  30  *  Known contributors to this file:
  31  *     Doug Hay, 1998
  32  *     Steve McClure, 1998
  33  *     Ron Koenderink, 2004-2007
  34  */
  35
  36 /*
  37  * EMPTHREADs for Windows NT.
  38  *
  39  * Actually, threads for any Win32 platform, like Win95, Win98, WinCE,
  40  * and whatever other toy OSs are in our future from Microsoft.
  41  *
  42  * WIN32 has a full pre-emptive threading environment.  But Empire can
  43  * not handle pre-emptive threading.  Thus, we will use the threads,
  44  * but limit the preemption using a Mutex.
  45  */
  46
  47 #include <config.h>
  48
  49 #include <errno.h>
  50 #include <signal.h>
  51 #include <stdio.h>
  52 #include <stdarg.h>
  53 #include <sys/types.h>
  54 #include <time.h>
  55 #include <winsock2.h>
  56 #undef NS_ALL
  57 #include <windows.h>
  58 #include <process.h>
  59 /* Note: unistd.h(posixio.c) is not thread-safe.
  60  * It may be used *only* while holding hThreadMutex.
  61  */
  62 #include "unistd.h"
  63 #include "misc.h"
  64 #include "empthread.h"
  65 #include "prototypes.h"
  66 #include "server.h"
  67
  68 #define loc_MIN_THREAD_STACK  16384
  69
  70 /************************
  71  * loc_Thread
  72  */
  73 struct loc_Thread {
  74
  75     /* The thread name, passed in at create time. */
  76     char szName[17];
  77
  78     /* True if this is the main line, and not a real thread. */
  79     BOOL bMainThread;
  80
  81     /* The user data passed in at create time. */
  82     void *pvUserData;
  83
  84     /* True if this thread has been killed. */
  85     BOOL bKilled;
  86
  87     /* The entry function for the thread. */
  88     void (*pfnEntry) (void *);
  89
  90     /* The system thread ID. */
  91     unsigned long ulThreadID;
  92
  93     /* An Mutex that the thread will wait/sleep on. */
  94     HANDLE hThreadEvent;
  95 };
  96
  97
  98 /************************
  99  * loc_RWLock
 100  *
 101  * Invariants
 102  *      must hold at function call, return, sleep
 103  *      and resume from sleep.
 104  *
 105  * any state:
 106  *      nwrite >= 0
 107  *      nread >= 0
 108
 109  * if unlocked:
 110  *      can_read set
 111  *      can_write set
 112  *      nwrite == 0
 113  *      nread == 0
 114  *
 115  * if read-locked without writers contending:
 116  *      can_read set
 117  *      can_write clear
 118  *      nwrite == 0
 119  *      nread > 0
 120  *
 121  * if read-locked with writers contending:
 122  *      can_read clear
 123  *      can_write clear
 124  *      nwrite > 0    #writers blocked
 125  *      nread > 0
 126  *
 127  * if write-locked:
 128  *      can_read clear
 129  *      can_write clear
 130  *      nwrite > 0    #writers blocked + 1
 131  *      nread == 0
 132  *
 133  * To ensure consistency, state normally changes only while the
 134  * thread changing it holds hThreadMutex.
 135  *
 136  */
 137 struct loc_RWLock {
 138     char name[17];      /* The thread name, passed in at create time. */
 139     HANDLE can_read;    /* Manual event -- allows read locks */
 140     HANDLE can_write;   /* Auto-reset event -- allows write locks */
 141     int nread;          /* number of active readers */
 142     int nwrite;         /* total number of writers (active and waiting) */
 143 };
 144
 145 /* This is the thread exclusion/non-premption mutex. */
 146 /* The running thread has this MUTEX, and all others are */
 147 /* either blocked on it, or waiting for some OS response. */
 148 static HANDLE hThreadMutex;
 149
 150 /* This is the thread startup event. */
 151 /* We use this to lockstep when we are starting up threads. */
 152 static HANDLE hThreadStartEvent;
 153
 154 /* This is an event used to wakeup the main thread */
 155 /* to start the shutdown sequence. */
 156 static HANDLE hShutdownEvent;
 157
 158 /* The Thread Local Storage index.  We store the pThread pointer */
 159 /* for each thread at this index. */
 160 static DWORD dwTLSIndex;
 161
 162 /* The current running thread. */
 163 static empth_t *pCurThread;
 164
 165 /* Ticks at start */
 166 static unsigned long ulTickAtStart;
 167
 168 /* Pointer out to global context.  "player". */
 169 /* From empth_init parameter. */
 170 static void **ppvUserData;
 171
 172 /* Global flags.  From empth_init parameter. */
 173 static int global_flags;
 174
 175
 176 /************************
 177  * loc_debug
 178  *
 179  * Print out the current thread's status??
 180  */
 181 static void
 182 loc_debug(const char *pszFmt, ...)
 183 {
 184     va_list vaList;
 185     unsigned long ulCurTick;
 186     unsigned long ulRunTick;
 187     unsigned long ulMs, ulSec, ulMin, ulHr;
 188     empth_t *pThread = TlsGetValue(dwTLSIndex);
 189     char buf[1024];
 190
 191     if ((global_flags & EMPTH_PRINT) != 0) {
 192
 193         /* Ticks are in milliseconds */
 194         ulCurTick = GetTickCount();
 195
 196         ulRunTick = ulCurTick - ulTickAtStart;
 197         ulMs = ulRunTick % 1000L;
 198         ulSec = (ulRunTick / 1000L) % 60L;
 199         ulMin = (ulRunTick / (60L * 1000L)) % 60L;
 200         ulHr = (ulRunTick / (60L * 60L * 1000L));
 201
 202         va_start(vaList, pszFmt);
 203         vsprintf(buf, pszFmt, vaList);
 204         va_end(vaList);
 205
 206         if (pThread) {
 207             printf("%ld:%02ld:%02ld.%03ld %17s: %s\n",
 208                    ulHr, ulMin, ulSec, ulMs, pThread->szName, buf);
 209         } else {
 210             printf("%ld:%02ld:%02ld.%03ld %17s: %s\n",
 211                    ulHr, ulMin, ulSec, ulMs, "UNKNOWN", buf);
 212         }
 213
 214     }
 215 }
 216
 217 /************************
 218  * loc_FreeThreadInfo
 219  */
 220 static void
 221 loc_FreeThreadInfo(empth_t *pThread)
 222 {
 223     if (pThread) {
 224         if (pThread->hThreadEvent)
 225             CloseHandle(pThread->hThreadEvent);
 226         memset(pThread, 0, sizeof(*pThread));
 227         free(pThread);
 228     }
 229 }
 230
 231 /************************
 232  * loc_RunThisThread
 233  *
 234  * This thread wants to run.
 235  * When this function returns, the globals are set to this thread
 236  * info, and the thread owns the MUTEX.
 237  */
 238 static void
 239 loc_RunThisThread(HANDLE hWaitObject)
 240 {
 241     HANDLE hWaitObjects[2];
 242
 243     empth_t *pThread = TlsGetValue(dwTLSIndex);
 244
 245     if (pThread->bKilled) {
 246         if (!pThread->bMainThread) {
 247             TlsSetValue(dwTLSIndex, NULL);
 248             loc_FreeThreadInfo(pThread);
 249             _endthread();
 250         }
 251     }
 252
 253     hWaitObjects[0] = hThreadMutex;
 254     hWaitObjects[1] = hWaitObject;
 255
 256     WaitForMultipleObjects(hWaitObject ? 2 : 1, hWaitObjects,
 257                            TRUE, INFINITE);
 258
 259     if (!pCurThread) {
 260         /* Set the globals to this thread. */
 261         *ppvUserData = pThread->pvUserData;
 262
 263         pCurThread = pThread;
 264     } else {
 265         /* Hmm, a problem, eh? */
 266         logerror("RunThisThread, someone already running.");
 267     }
 268 }
 269
 270 /************************
 271  * loc_BlockThisThread
 272  *
 273  * This thread was running.  It no longer wants to.
 274  */
 275 static void
 276 loc_BlockThisThread(void)
 277 {
 278     empth_t *pThread = TlsGetValue(dwTLSIndex);
 279
 280     if (pCurThread == pThread) {
 281         /* Reset the globals back to original */
 282
 283         pCurThread = NULL;
 284         *ppvUserData = NULL;
 285
 286         /* Release the MUTEX */
 287         ReleaseMutex(hThreadMutex);
 288     } else {
 289         /* Hmm, this thread was not the running one. */
 290         logerror("BlockThisThread, not running.");
 291     }
 292 }
 293
 294 /************************
 295  * loc_Exit_Handler
 296  *
 297  * Ctrl-C, Ctrl-Break, Window-Closure, User-Logging-Off or
 298  * System-Shutdown will initiate a shutdown.
 299  * This is done by calling empth_request_shutdown()
 300  */
 301 static BOOL WINAPI
 302 loc_Exit_Handler(DWORD fdwCtrlType)
 303 {
 304     switch (fdwCtrlType) {
 305         case CTRL_C_EVENT:
 306         case CTRL_CLOSE_EVENT:
 307         case CTRL_BREAK_EVENT:
 308         case CTRL_LOGOFF_EVENT:
 309         case CTRL_SHUTDOWN_EVENT:
 310             empth_request_shutdown();
 311             return TRUE;
 312         default:
 313             return FALSE;
 314     }
 315 }
 316
 317 /************************
 318  * empth_threadMain
 319  *
 320  * This is the main line of each thread.
 321  * This is really a static local func....
 322  * Note: As the POSIX compatibility layer is not thread safe
 323  * this function can not open or create any files or sockets until
 324  * loc_RunThisThread() is called
 325  */
 326 static void
 327 empth_threadMain(void *pvData)
 328 {
 329     empth_t *pThread = pvData;
 330
 331     /* Out of here... */
 332     if (!pvData)
 333         return;
 334
 335     /* Store pThread on this thread. */
 336     TlsSetValue(dwTLSIndex, pvData);
 337
 338     /* Get the ID of the thread. */
 339     pThread->ulThreadID = GetCurrentThreadId();
 340
 341     /* Signal that the thread has started. */
 342     SetEvent(hThreadStartEvent);
 343
 344     /* Switch to this thread context */
 345     loc_RunThisThread(NULL);
 346
 347     /* Run the thread. */
 348     if (pThread->pfnEntry)
 349         pThread->pfnEntry(pThread->pvUserData);
 350
 351     /* Kill the thread. */
 352     empth_exit();
 353 }
 354
 355 /************************
 356  * empth_init
 357  *
 358  * Initialize the thread environment.
 359  *
 360  * This is called from the program main line.
 361  */
 362 int
 363 empth_init(void **ctx_ptr, int flags)
 364 {
 365     empth_t *pThread = NULL;
 366
 367     ulTickAtStart = GetTickCount();
 368     ppvUserData = ctx_ptr;
 369     global_flags = flags;
 370     dwTLSIndex = TlsAlloc();
 371
 372     /* Create the thread mutex. */
 373     /* Initally unowned. */
 374     hThreadMutex = CreateMutex(NULL, FALSE, NULL);
 375     if (!hThreadMutex) {
 376         logerror("Failed to create mutex %lu", GetLastError());
 377         return 0;
 378     }
 379
 380     /* Create the thread start event. */
 381     /* Automatic state reset. */
 382     hThreadStartEvent = CreateEvent(NULL, FALSE, FALSE, NULL);
 383     if (!hThreadStartEvent) {
 384         logerror("Failed to create start event %lu", GetLastError());
 385         return 0;
 386     }
 387
 388     /* Create the shutdown event for the main thread. */
 389     /* Manual reset */
 390     hShutdownEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
 391     if (!hShutdownEvent) {
 392         logerror("Failed to create shutdown event %lu", GetLastError());
 393         return 0;
 394     }
 395     SetConsoleCtrlHandler(loc_Exit_Handler, TRUE);
 396
 397     /* Create the global Thread context. */
 398     pThread = malloc(sizeof(*pThread));
 399     if (!pThread) {
 400         logerror("not enough memory to create main thread.");
 401         return 0;
 402     }
 403     memset(pThread, 0, sizeof(*pThread));
 404
 405     strncpy(pThread->szName, "Main", sizeof(pThread->szName) - 1);
 406     pThread->ulThreadID = GetCurrentThreadId();
 407     pThread->bMainThread = TRUE;
 408
 409     TlsSetValue(dwTLSIndex, pThread);
 410
 411     /* Make this the running thread. */
 412     loc_RunThisThread(NULL);
 413
 414     logerror("NT pthreads initialized");
 415     return 0;
 416 }
 417
 418
 419 /************************
 420  * empth_create
 421  *
 422  * Create a new thread.
 423  *
 424  * entry - entry point function for thread.
 425  * size  - stack size.
 426  * flags - debug control.
 427  *           LWP_STACKCHECK  - not needed
 428  * name  - name of the thread, for debug.
 429  * ud    - "user data".  The "ctx_ptr" gets this value
 430  *         when the thread is active.
 431  *         It is also passed to the entry function...
 432  */
 433 empth_t *
 434 empth_create(void (*entry)(void *), int size, int flags,
 435              char *name, void *ud)
 436 {
 437     empth_t *pThread = NULL;
 438
 439     loc_debug("creating new thread %s", name);
 440
 441     pThread = malloc(sizeof(*pThread));
 442     if (!pThread) {
 443         logerror("not enough memory to create thread %s", name);
 444         return NULL;
 445     }
 446     memset(pThread, 0, sizeof(*pThread));
 447
 448     strncpy(pThread->szName, name, sizeof(pThread->szName) - 1);
 449     pThread->pvUserData = ud;
 450     pThread->pfnEntry = entry;
 451     pThread->bMainThread = FALSE;
 452
 453     /* Create thread event, auto reset. */
 454     pThread->hThreadEvent = CreateEvent(NULL, FALSE, FALSE, NULL);
 455
 456     if (size < loc_MIN_THREAD_STACK)
 457         size = loc_MIN_THREAD_STACK;
 458
 459     pThread->ulThreadID = _beginthread(empth_threadMain, size, pThread);
 460     if (pThread->ulThreadID == 1L) {
 461         logerror("can not create thread: %s: %s", name, strerror(errno));
 462         goto bad;
 463     }
 464
 465     loc_debug("new thread id is %ld", pThread->ulThreadID);
 466     empth_yield();
 467     return pThread;
 468
 469   bad:
 470     if (pThread) {
 471         loc_FreeThreadInfo(pThread);
 472     }
 473     return NULL;
 474 }
 475
 476
 477 /************************
 478  * empth_self
 479  */
 480 empth_t *
 481 empth_self(void)
 482 {
 483     empth_t *pThread = TlsGetValue(dwTLSIndex);
 484
 485     return pThread;
 486 }
 487
 488 /************************
 489  * empth_exit
 490  */
 491 void
 492 empth_exit(void)
 493 {
 494     empth_t *pThread = TlsGetValue(dwTLSIndex);
 495
 496     loc_debug("empth_exit");
 497     loc_BlockThisThread();
 498
 499     TlsSetValue(dwTLSIndex, NULL);
 500     loc_FreeThreadInfo(pThread);
 501     _endthread();
 502 }
 503
 504 /************************
 505  * empth_yield
 506  *
 507  * Yield processing to another thread.
 508  */
 509 void
 510 empth_yield(void)
 511 {
 512     loc_BlockThisThread();
 513     loc_RunThisThread(NULL);
 514 }
 515
 516 /************************
 517  * empth_terminate
 518  *
 519  * Kill off the thread.
 520  */
 521 void
 522 empth_terminate(empth_t *pThread)
 523 {
 524     loc_debug("killing thread %s", pThread->szName);
 525     pThread->bKilled = TRUE;
 526
 527     SetEvent(pThread->hThreadEvent);
 528 }
 529
 530 /************************
 531  * empth_select
 532  *
 533  * Do a select on the given file.
 534  * Wait for IO on it.
 535  *
 536  * This would be one of the main functions used within gen\io.c
 537  */
 538 void
 539 empth_select(int fd, int flags)
 540 {
 541     int handle;
 542     WSAEVENT hEventObject[2];
 543     empth_t *pThread = TlsGetValue(dwTLSIndex);
 544
 545     loc_debug("%s select on %d",
 546               flags == EMPTH_FD_READ ? "read" : "write", fd);
 547     loc_BlockThisThread();
 548
 549     hEventObject[0] = WSACreateEvent();
 550     hEventObject[1] = pThread->hThreadEvent;
 551
 552     handle = posix_fd2socket(fd);
 553     CANT_HAPPEN(handle < 0);
 554
 555     if (flags == EMPTH_FD_READ)
 556         WSAEventSelect(handle, hEventObject[0], FD_READ | FD_ACCEPT | FD_CLOSE);
 557     else if (flags == EMPTH_FD_WRITE)
 558         WSAEventSelect(handle, hEventObject[0], FD_WRITE | FD_CLOSE);
 559     else {
 560         logerror("bad flag %d passed to empth_select", flags);
 561         empth_exit();
 562     }
 563
 564     WSAWaitForMultipleEvents(2, hEventObject, FALSE, WSA_INFINITE, FALSE);
 565
 566     WSAEventSelect(handle, hEventObject[0], 0);
 567
 568     WSACloseEvent(hEventObject[0]);
 569
 570     loc_RunThisThread(NULL);
 571 }
 572
 573 /************************
 574  * empth_wakeup
 575  *
 576  * Wake up the specified thread.
 577  */
 578 void
 579 empth_wakeup(empth_t *pThread)
 580 {
 581     loc_debug("waking up thread %s", pThread->szName);
 582
 583     /* Let it run if it is blocked... */
 584     SetEvent(pThread->hThreadEvent);
 585 }
 586
 587 /************************
 588  * empth_sleep
 589  *
 590  * Put the given thread to sleep...
 591  */
 592 int
 593 empth_sleep(time_t until)
 594 {
 595     long lSec;
 596     empth_t *pThread = TlsGetValue(dwTLSIndex);
 597     int iReturn = 0;
 598
 599     while (!iReturn && ((lSec = until - time(0)) > 0)) {
 600         loc_BlockThisThread();
 601         loc_debug("going to sleep %ld sec", lSec);
 602
 603         if (WaitForSingleObject(pThread->hThreadEvent, lSec * 1000L) !=
 604             WAIT_TIMEOUT)
 605             iReturn = -1;
 606
 607         loc_debug("sleep done. Waiting to run.");
 608         loc_RunThisThread(NULL);
 609     }
 610     return iReturn;
 611 }
 612
 613 /************************
 614  * empth_request_shutdown
 615  *
 616  * This wakes up empth_wait_for_signal() so shutdown can proceed.
 617  * This is done by signalling hShutdownEvent.
 618  */
 619 void
 620 empth_request_shutdown(void)
 621 {
 622     SetEvent(hShutdownEvent);
 623 }
 624
 625 int
 626 empth_wait_for_signal(void)
 627 {
 628     loc_BlockThisThread();
 629     loc_RunThisThread(hShutdownEvent);
 630     return SIGTERM;
 631 }
 632
 633 empth_rwlock_t *
 634 empth_rwlock_create(char *name)
 635 {
 636     empth_rwlock_t *rwlock;
 637
 638     rwlock = malloc(sizeof(*rwlock));
 639     if (!rwlock)
 640         return NULL;
 641
 642     memset(rwlock, 0, sizeof(*rwlock));
 643     strncpy(rwlock->name, name, sizeof(rwlock->name) - 1);
 644
 645     if ((rwlock->can_read = CreateEvent(NULL, TRUE, TRUE, NULL)) == NULL) {
 646         logerror("rwlock_create: failed to create reader event %s at %s:%d",
 647             name, __FILE__, __LINE__);
 648         free(rwlock);
 649         return NULL;
 650     }
 651
 652     if ((rwlock->can_write = CreateEvent(NULL, FALSE, TRUE, NULL)) == NULL) {
 653         logerror("rwlock_create: failed to create writer event %s at %s:%d",
 654             name, __FILE__, __LINE__);
 655         CloseHandle(rwlock->can_read);
 656         free(rwlock);
 657         return NULL;
 658     }
 659     return rwlock;
 660 }
 661
 662 void
 663 empth_rwlock_destroy(empth_rwlock_t *rwlock)
 664 {
 665     if (CANT_HAPPEN(rwlock->nread || rwlock->nwrite))
 666         return;
 667     CloseHandle(rwlock->can_read);
 668     CloseHandle(rwlock->can_write);
 669     free(rwlock);
 670 }
 671
 672 void
 673 empth_rwlock_wrlock(empth_rwlock_t *rwlock)
 674 {
 675     /* block any new readers */
 676     ResetEvent(rwlock->can_read);
 677     rwlock->nwrite++;
 678     loc_BlockThisThread();
 679     loc_RunThisThread(rwlock->can_write);
 680     CANT_HAPPEN(rwlock->nread != 0);
 681 }
 682
 683 void
 684 empth_rwlock_rdlock(empth_rwlock_t *rwlock)
 685 {
 686     loc_BlockThisThread();
 687     loc_RunThisThread(rwlock->can_read);
 688     ResetEvent(rwlock->can_write);
 689     rwlock->nread++;
 690 }
 691
 692 void
 693 empth_rwlock_unlock(empth_rwlock_t *rwlock)
 694 {
 695     if (CANT_HAPPEN(!rwlock->nread && !rwlock->nwrite))
 696         return;
 697    if (rwlock->nread) { /* holding read lock */
 698         rwlock->nread--;
 699         if (rwlock->nread == 0)
 700             SetEvent(rwlock->can_write);
 701     } else {
 702         rwlock->nwrite--;
 703         SetEvent(rwlock->can_write);
 704     }
 705     if (rwlock->nwrite == 0)
 706         SetEvent(rwlock->can_read);
 707 }