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
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.
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.
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
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.
28 * ntthread.c: Interface from Empire threads to Windows NT threads
30 * Known contributors to this file:
33 * Ron Koenderink, 2004-2005
37 * EMPTHREADs for Windows NT.
39 * Actually, threads for any Win32 platform, like Win95, Win98, WinCE,
40 * and whatever other toy OSs are in our future from Microsoft.
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.
50 #include <sys/types.h>
55 #include "empthread.h"
56 #include "prototypes.h"
64 #define loc_MIN_THREAD_STACK 16384
66 /************************
71 /* The thread name, passed in at create time. */
73 /* The thread description, passed in at create time. */
76 /* True if this is the main line, and not a real thread. */
79 /* The user data passed in at create time. */
82 /* True if this thread has been killed. */
85 /* The entry function for the thread. */
86 void (*pfnEntry) (void *);
88 /* The system thread ID. */
89 unsigned long ulThreadID;
91 /* An Event sem that the thread will wait/sleep on. */
96 /************************
103 /* An exclusion semaphore for this sem. */
105 /* An Event sem that the thread(s) will sleep on. */
108 /* The count variable */
112 /* This is the thread exclusion/non-premption mutex. */
113 /* The running thread has this MUTEX, and all others are */
114 /* either blocked on it, or waiting for some OS response. */
115 static HANDLE hThreadMutex;
117 /* This is the thread startup event sem. */
118 /* We use this to lockstep when we are starting up threads. */
119 static HANDLE hThreadStartEvent;
121 /* This is an event used to wakeup the main thread */
122 /* to start the shutdown sequence. */
123 static HANDLE hShutdownEvent;
125 /* The Thread Local Storage index. We store the pThread pointer */
126 /* for each thread at this index. */
127 static DWORD dwTLSIndex;
129 /* The current running thread. */
130 static empth_t *pCurThread;
133 static unsigned long ulTickAtStart;
135 /* Pointer out to global context. "player". */
136 /* From empth_init parameter. */
137 static void **ppvUserData;
139 /* Global flags. From empth_init parameter. */
140 static int global_flags;
143 /************************
146 * Print out the current thread's status??
149 loc_debug(const char *pszFmt, ...)
152 unsigned long ulCurTick;
153 unsigned long ulRunTick;
154 unsigned long ulMs, ulSec, ulMin, ulHr;
155 empth_t *pThread = TlsGetValue(dwTLSIndex);
158 if ((global_flags & EMPTH_PRINT) != 0) {
160 /* Ticks are in milliseconds */
161 ulCurTick = GetTickCount();
163 ulRunTick = ulCurTick - ulTickAtStart;
164 ulMs = ulRunTick % 1000L;
165 ulSec = (ulRunTick / 1000L) % 60L;
166 ulMin = (ulRunTick / (60L * 1000L)) % 60L;
167 ulHr = (ulRunTick / (60L * 60L * 1000L));
169 va_start(vaList, pszFmt);
170 vsprintf(buf, pszFmt, vaList);
174 printf("%ld:%02ld:%02ld.%03ld %17s: %s\n",
175 ulHr, ulMin, ulSec, ulMs, pThread->szName, buf);
177 printf("%ld:%02ld:%02ld.%03ld %17s: %s\n",
178 ulHr, ulMin, ulSec, ulMs, "UNKNOWN", buf);
184 /************************
188 loc_FreeThreadInfo(empth_t *pThread)
191 if (pThread->hThreadEvent)
192 CloseHandle(pThread->hThreadEvent);
193 memset(pThread, 0, sizeof(*pThread));
198 /************************
201 * This thread wants to run.
202 * When this function returns, the globals are set to this thread
203 * info, and the thread owns the MUTEX sem.
206 loc_RunThisThread(void)
208 empth_t *pThread = TlsGetValue(dwTLSIndex);
210 if (pThread->bKilled) {
211 if (!pThread->bMainThread) {
212 TlsSetValue(dwTLSIndex, NULL);
213 loc_FreeThreadInfo(pThread);
218 /* Get the MUTEX semaphore, wait forever. */
219 WaitForSingleObject(hThreadMutex, INFINITE);
222 /* Set the globals to this thread. */
223 *ppvUserData = pThread->pvUserData;
225 pCurThread = pThread;
227 /* Hmm, a problem, eh? */
228 logerror("RunThisThread, someone already running.");
232 /************************
233 * loc_BlockThisThread
235 * This thread was running. It no longer wants to.
238 loc_BlockThisThread(void)
240 empth_t *pThread = TlsGetValue(dwTLSIndex);
242 if (pCurThread == pThread) {
243 /* Reset the globals back to original */
248 /* Release the MUTEX */
249 ReleaseMutex(hThreadMutex);
251 /* Hmm, this thread was not the running one. */
252 logerror("BlockThisThread, not running.");
256 /************************
259 * Ctrl-C, Ctrl-Break, Window-Closure, User-Logging-Off or
260 * System-Shutdown will initiate a shutdown.
261 * This is done by calling empth_request_shutdown()
264 loc_Exit_Handler(DWORD fdwCtrlType)
266 switch (fdwCtrlType) {
268 case CTRL_CLOSE_EVENT:
269 case CTRL_BREAK_EVENT:
270 case CTRL_LOGOFF_EVENT:
271 case CTRL_SHUTDOWN_EVENT:
272 empth_request_shutdown();
279 /************************
282 * This is the main line of each thread.
283 * This is really a static local func....
286 empth_threadMain(void *pvData)
290 empth_t *pThread = pvData;
296 /* Store pThread on this thread. */
297 TlsSetValue(dwTLSIndex, pvData);
299 /* Get the ID of the thread. */
300 pThread->ulThreadID = GetCurrentThreadId();
302 /* Signal that the thread has started. */
303 SetEvent(hThreadStartEvent);
305 /* seed the rand() function */
307 srand(now ^ (unsigned)pThread);
309 /* Switch to this thread context */
312 /* Run the thread. */
313 if (pThread->pfnEntry)
314 pThread->pfnEntry(pThread->pvUserData);
316 /* Kill the thread. */
320 /************************
323 * Initialize the thread environment.
325 * This is called from the program main line.
328 empth_init(void **ctx_ptr, int flags)
330 empth_t *pThread = NULL;
332 ulTickAtStart = GetTickCount();
333 ppvUserData = ctx_ptr;
334 global_flags = flags;
335 dwTLSIndex = TlsAlloc();
337 /* Create the thread mutex sem. */
338 /* Initally unowned. */
339 hThreadMutex = CreateMutex(NULL, FALSE, NULL);
341 logerror("Failed to create mutex %lu", GetLastError());
345 /* Create the thread start event sem. */
346 /* Automatic state reset. */
347 hThreadStartEvent = CreateEvent(NULL, FALSE, FALSE, NULL);
348 if (!hThreadStartEvent) {
349 logerror("Failed to create start event %lu", GetLastError());
353 /* Create the shutdown event for the main thread. */
355 hShutdownEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
356 if (!hShutdownEvent) {
357 logerror("Failed to create shutdown event %lu", GetLastError());
360 SetConsoleCtrlHandler((PHANDLER_ROUTINE)loc_Exit_Handler, TRUE);
362 /* Create the global Thread context. */
363 pThread = malloc(sizeof(*pThread));
365 logerror("not enough memory to create main thread.");
368 memset(pThread, 0, sizeof(*pThread));
370 strncpy(pThread->szName, "Main", sizeof(pThread->szName) - 1);
371 strncpy(pThread->szDesc, "The main process",
372 sizeof(pThread->szDesc) - 1);
373 pThread->ulThreadID = GetCurrentThreadId();
374 pThread->bMainThread = TRUE;
376 TlsSetValue(dwTLSIndex, pThread);
378 /* Make this the running thread. */
381 logerror("NT pthreads initialized");
386 /************************
389 * Create a new thread.
391 * prio - priority, not particularly useful in our context.
392 * entry - entry point function for thread.
394 * flags - debug control.
395 * LWP_STACKCHECK - not needed
396 * name - name of the thread, for debug.
397 * desc - description of thread, for debug.
398 * ud - "user data". The "ctx_ptr" gets this value
399 * when the thread is active.
400 * It is also passed to the entry function...
403 empth_create(int prio, void (*entry)(void *), int size, int flags,
404 char *name, char *desc, void *ud)
406 empth_t *pThread = NULL;
408 loc_debug("creating new thread %s:%s", name, desc);
410 pThread = malloc(sizeof(*pThread));
412 logerror("not enough memory to create thread: %s (%s)",
416 memset(pThread, 0, sizeof(*pThread));
418 strncpy(pThread->szName, name, sizeof(pThread->szName) - 1);
419 strncpy(pThread->szDesc, desc, sizeof(pThread->szDesc) - 1);
420 pThread->pvUserData = ud;
421 pThread->pfnEntry = entry;
422 pThread->bMainThread = FALSE;
424 /* Create thread event sem, auto reset. */
425 pThread->hThreadEvent = CreateEvent(NULL, FALSE, FALSE, NULL);
427 if (size < loc_MIN_THREAD_STACK)
428 size = loc_MIN_THREAD_STACK;
430 pThread->ulThreadID = _beginthread(empth_threadMain, size, pThread);
431 if (pThread->ulThreadID == -1) {
432 logerror("can not create thread: %s (%s): %s",
433 name, desc, strerror(errno));
437 loc_debug("new thread id is %ld", pThread->ulThreadID);
443 loc_FreeThreadInfo(pThread);
449 /************************
455 empth_t *pThread = TlsGetValue(dwTLSIndex);
460 /************************
466 empth_t *pThread = TlsGetValue(dwTLSIndex);
468 loc_debug("empth_exit");
469 loc_BlockThisThread();
471 TlsSetValue(dwTLSIndex, NULL);
472 loc_FreeThreadInfo(pThread);
476 /************************
479 * Yield processing to another thread.
484 loc_BlockThisThread();
488 /************************
491 * Kill off the thread.
494 empth_terminate(empth_t *pThread)
496 loc_debug("killing thread %s", pThread->szName);
497 pThread->bKilled = TRUE;
499 SetEvent(pThread->hThreadEvent);
502 /************************
505 * Do a select on the given file.
508 * This would be one of the main functions used within gen\io.c
511 empth_select(int fd, int flags)
513 WSAEVENT hEventObject[2];
514 empth_t *pThread = TlsGetValue(dwTLSIndex);
516 loc_debug("%s select on %d",
517 flags == EMPTH_FD_READ ? "read" : "write", fd);
518 loc_BlockThisThread();
520 hEventObject[0] = WSACreateEvent();
521 hEventObject[1] = pThread->hThreadEvent;
523 if (flags == EMPTH_FD_READ)
524 WSAEventSelect(fd, hEventObject[0], FD_READ | FD_ACCEPT | FD_CLOSE);
525 else if (flags == EMPTH_FD_WRITE)
526 WSAEventSelect(fd, hEventObject[0], FD_WRITE | FD_CLOSE);
528 logerror("bad flag %d passed to empth_select", flags);
532 WSAWaitForMultipleEvents(2, hEventObject, FALSE, WSA_INFINITE, FALSE);
534 WSAEventSelect(fd, hEventObject[0], 0);
536 WSACloseEvent(hEventObject[0]);
541 /************************
544 * Wake up the specified thread.
547 empth_wakeup(empth_t *pThread)
549 loc_debug("waking up thread %s", pThread->szName);
551 /* Let it run if it is blocked... */
552 SetEvent(pThread->hThreadEvent);
555 /************************
558 * Put the given thread to sleep...
561 empth_sleep(time_t until)
565 loc_BlockThisThread();
567 while ((lSec = until - time(0)) > 0) {
568 loc_debug("going to sleep %ld sec", lSec);
572 loc_debug("sleep done. Waiting to run.");
577 /************************
578 * empth_request_shutdown
580 * This wakes up empth_wait_for_shutdown() so shutdown can proceed.
581 * This is done by signalling hShutdownEvent.
584 empth_request_shutdown(void)
586 SetEvent(hShutdownEvent);
590 empth_wait_for_shutdown(void)
592 /* Get the MUTEX semaphore, wait the number of MS */
593 WaitForSingleObject(hShutdownEvent, INFINITE);
599 /************************
602 * Create a signalling semaphore.
605 empth_sem_create(char *name, int cnt)
609 pSem = malloc(sizeof(*pSem));
611 logerror("out of memory at %s:%d", __FILE__, __LINE__);
615 memset(pSem, 0, sizeof(pSem));
616 strncpy(pSem->szName, name, sizeof(pSem->szName) - 1);
618 pSem->hMutex = CreateMutex(NULL, FALSE, NULL);
619 pSem->hEvent = CreateEvent(NULL, FALSE, FALSE, NULL);
625 /************************
628 * Hit/signal the specified semaphore.
631 empth_sem_signal(empth_sem_t *pSem)
633 loc_debug("signal on semaphore %s:%d", pSem->szName, pSem->count);
635 /* Wait for the Semaphore */
636 WaitForSingleObject(pSem->hMutex, INFINITE);
638 if (pSem->count++ < 0) {
639 SetEvent(pSem->hEvent);
642 ReleaseMutex(pSem->hMutex);
645 /************************
648 * Wait for the specified signal semaphore to be signaled.
651 empth_sem_wait(empth_sem_t *pSem)
653 empth_t *pThread = TlsGetValue(dwTLSIndex);
655 loc_debug("wait on semaphore %s:%d", pSem->szName, pSem->count);
657 /* Remove the thread from the running state. */
658 loc_BlockThisThread();
660 /* Wait for the Semaphore */
661 WaitForSingleObject(pSem->hMutex, INFINITE);
662 if (--pSem->count < 0) {
663 loc_debug("blocking");
664 ReleaseMutex(pSem->hMutex);
666 WaitForSingleObject(pSem->hEvent, INFINITE);
668 loc_debug("waking up");
670 ReleaseMutex(pSem->hMutex);