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