/*
===========================================================================
Doom 3 GPL Source Code
Copyright (C) 1999-2011 id Software LLC, a ZeniMax Media company.
This file is part of the Doom 3 GPL Source Code ("Doom 3 Source Code").
Doom 3 Source Code is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Doom 3 Source Code is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with Doom 3 Source Code. If not, see .
In addition, the Doom 3 Source Code is also subject to certain additional terms. You should have received a copy of these additional terms immediately following the terms and conditions of the GNU General Public License which accompanied the Doom 3 Source Code. If not, please request a copy in writing from id Software at the address below.
If you have questions concerning this license or the applicable additional terms, you may contact in writing id Software LLC, c/o ZeniMax Media Inc., Suite 120, Rockville, Maryland 20850 USA.
===========================================================================
*/
#include
#include
#include
#include
#include "sys/platform.h"
#include "framework/Common.h"
#include "sys/sys_public.h"
static SDL_mutex *mutex[MAX_CRITICAL_SECTIONS] = { };
static SDL_cond *cond[MAX_TRIGGER_EVENTS] = { };
static bool signaled[MAX_TRIGGER_EVENTS] = { };
static bool waiting[MAX_TRIGGER_EVENTS] = { };
static xthreadInfo *thread[MAX_THREADS] = { };
static size_t thread_count = 0;
/*
==============
Sys_Sleep
==============
*/
void Sys_Sleep(int msec) {
SDL_Delay(msec);
}
/*
================
Sys_Milliseconds
================
*/
unsigned int Sys_Milliseconds() {
return SDL_GetTicks();
}
/*
==================
Sys_InitThreads
==================
*/
void Sys_InitThreads() {
// critical sections
for (int i = 0; i < MAX_CRITICAL_SECTIONS; i++) {
mutex[i] = SDL_CreateMutex();
if (!mutex[i]) {
Sys_Printf("ERROR: SDL_CreateMutex failed\n");
return;
}
}
// events
for (int i = 0; i < MAX_TRIGGER_EVENTS; i++) {
cond[i] = SDL_CreateCond();
if (!cond[i]) {
Sys_Printf("ERROR: SDL_CreateCond failed\n");
return;
}
signaled[i] = false;
waiting[i] = false;
}
// threads
for (int i = 0; i < MAX_THREADS; i++)
thread[i] = NULL;
thread_count = 0;
}
/*
==================
Sys_ShutdownThreads
==================
*/
void Sys_ShutdownThreads() {
// threads
for (int i = 0; i < MAX_THREADS; i++) {
if (!thread[i])
continue;
Sys_Printf("WARNING: Thread '%s' still running\n", thread[i]->name);
#if SDL_VERSION_ATLEAST(2, 0, 0)
// TODO no equivalent in SDL2
#else
SDL_KillThread(thread[i]->threadHandle);
#endif
thread[i] = NULL;
}
// events
for (int i = 0; i < MAX_TRIGGER_EVENTS; i++) {
SDL_DestroyCond(cond[i]);
cond[i] = NULL;
signaled[i] = false;
waiting[i] = false;
}
// critical sections
for (int i = 0; i < MAX_CRITICAL_SECTIONS; i++) {
SDL_DestroyMutex(mutex[i]);
mutex[i] = NULL;
}
}
/*
==================
Sys_EnterCriticalSection
==================
*/
void Sys_EnterCriticalSection(int index) {
assert(index >= 0 && index < MAX_CRITICAL_SECTIONS);
if (SDL_LockMutex(mutex[index]) != 0)
common->Error("ERROR: SDL_LockMutex failed\n");
}
/*
==================
Sys_LeaveCriticalSection
==================
*/
void Sys_LeaveCriticalSection(int index) {
assert(index >= 0 && index < MAX_CRITICAL_SECTIONS);
if (SDL_UnlockMutex(mutex[index]) != 0)
common->Error("ERROR: SDL_UnlockMutex failed\n");
}
/*
======================================================
wait and trigger events
we use a single lock to manipulate the conditions, CRITICAL_SECTION_SYS
the semantics match the win32 version. signals raised while no one is waiting stay raised until a wait happens (which then does a simple pass-through)
NOTE: we use the same mutex for all the events. I don't think this would become much of a problem
cond_wait unlocks atomically with setting the wait condition, and locks it back before exiting the function
the potential for time wasting lock waits is very low
======================================================
*/
/*
==================
Sys_WaitForEvent
==================
*/
void Sys_WaitForEvent(int index) {
assert(index >= 0 && index < MAX_TRIGGER_EVENTS);
Sys_EnterCriticalSection(CRITICAL_SECTION_SYS);
assert(!waiting[index]); // WaitForEvent from multiple threads? that wouldn't be good
if (signaled[index]) {
// emulate windows behaviour: signal has been raised already. clear and keep going
signaled[index] = false;
} else {
waiting[index] = true;
if (SDL_CondWait(cond[index], mutex[CRITICAL_SECTION_SYS]) != 0)
common->Error("ERROR: SDL_CondWait failed\n");
waiting[index] = false;
}
Sys_LeaveCriticalSection(CRITICAL_SECTION_SYS);
}
/*
==================
Sys_TriggerEvent
==================
*/
void Sys_TriggerEvent(int index) {
assert(index >= 0 && index < MAX_TRIGGER_EVENTS);
Sys_EnterCriticalSection(CRITICAL_SECTION_SYS);
if (waiting[index]) {
if (SDL_CondSignal(cond[index]) != 0)
common->Error("ERROR: SDL_CondSignal failed\n");
} else {
// emulate windows behaviour: if no thread is waiting, leave the signal on so next wait keeps going
signaled[index] = true;
}
Sys_LeaveCriticalSection(CRITICAL_SECTION_SYS);
}
/*
==================
Sys_CreateThread
==================
*/
void Sys_CreateThread(xthread_t function, void *parms, xthreadInfo& info, const char *name) {
Sys_EnterCriticalSection();
#if SDL_VERSION_ATLEAST(2, 0, 0)
SDL_Thread *t = SDL_CreateThread(function, name, parms);
#else
SDL_Thread *t = SDL_CreateThread(function, parms);
#endif
if (!t) {
common->Error("ERROR: SDL_thread for '%s' failed\n", name);
Sys_LeaveCriticalSection();
return;
}
info.name = name;
info.threadHandle = t;
info.threadId = SDL_GetThreadID(t);
if (thread_count < MAX_THREADS)
thread[thread_count++] = &info;
else
common->DPrintf("WARNING: MAX_THREADS reached\n");
Sys_LeaveCriticalSection();
}
/*
==================
Sys_DestroyThread
==================
*/
void Sys_DestroyThread(xthreadInfo& info) {
assert(info.threadHandle);
SDL_WaitThread(info.threadHandle, NULL);
info.name = NULL;
info.threadHandle = NULL;
info.threadId = 0;
Sys_EnterCriticalSection();
for (int i = 0; i < thread_count; i++) {
if (&info == thread[i]) {
thread[i] = NULL;
int j;
for (j = i + 1; j < thread_count; j++)
thread[j - 1] = thread[j];
thread[j - 1] = NULL;
thread_count--;
break;
}
}
Sys_LeaveCriticalSection( );
}
/*
==================
Sys_GetThreadName
find the name of the calling thread
==================
*/
const char *Sys_GetThreadName(int *index) {
const char *name;
Sys_EnterCriticalSection();
unsigned int id = SDL_ThreadID();
for (int i = 0; i < thread_count; i++) {
if (id == thread[i]->threadId) {
if (index)
*index = i;
name = thread[i]->name;
Sys_LeaveCriticalSection();
return name;
}
}
if (index)
*index = -1;
Sys_LeaveCriticalSection();
return "main";
}