src/thread/SDL_thread.c
author Sam Lantinga <slouken@libsdl.org>
Tue, 07 Feb 2006 06:59:48 +0000
changeset 1336 3692456e7b0f
parent 1330 450721ad5436
child 1338 604d73db6802
permissions -rw-r--r--
Use SDL_ prefixed versions of C library functions.
FIXME:
Change #include <stdlib.h> to #include "SDL_stdlib.h"
Change #include <string.h> to #include "SDL_string.h"
Make sure nothing else broke because of this...
slouken@0
     1
/*
slouken@0
     2
    SDL - Simple DirectMedia Layer
slouken@1312
     3
    Copyright (C) 1997-2006 Sam Lantinga
slouken@0
     4
slouken@0
     5
    This library is free software; you can redistribute it and/or
slouken@1312
     6
    modify it under the terms of the GNU Lesser General Public
slouken@0
     7
    License as published by the Free Software Foundation; either
slouken@1312
     8
    version 2.1 of the License, or (at your option) any later version.
slouken@0
     9
slouken@0
    10
    This library is distributed in the hope that it will be useful,
slouken@0
    11
    but WITHOUT ANY WARRANTY; without even the implied warranty of
slouken@0
    12
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
slouken@1312
    13
    Lesser General Public License for more details.
slouken@0
    14
slouken@1312
    15
    You should have received a copy of the GNU Lesser General Public
slouken@1312
    16
    License along with this library; if not, write to the Free Software
slouken@1312
    17
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
slouken@0
    18
slouken@0
    19
    Sam Lantinga
slouken@252
    20
    slouken@libsdl.org
slouken@0
    21
*/
slouken@0
    22
slouken@0
    23
/* System independent thread management routines for SDL */
slouken@0
    24
slouken@0
    25
#include "SDL_error.h"
slouken@0
    26
#include "SDL_mutex.h"
slouken@0
    27
#include "SDL_thread.h"
slouken@1330
    28
#include "SDL_stdlib.h"
slouken@1330
    29
#include "SDL_string.h"
slouken@0
    30
#include "SDL_thread_c.h"
slouken@0
    31
#include "SDL_systhread.h"
slouken@0
    32
slouken@0
    33
#define ARRAY_CHUNKSIZE	32
slouken@0
    34
/* The array of threads currently active in the application
slouken@0
    35
   (except the main thread)
slouken@0
    36
   The manipulation of an array here is safer than using a linked list.
slouken@0
    37
*/
slouken@0
    38
static int SDL_maxthreads = 0;
slouken@0
    39
static int SDL_numthreads = 0;
slouken@0
    40
static SDL_Thread **SDL_Threads = NULL;
slouken@0
    41
static SDL_mutex *thread_lock = NULL;
slouken@0
    42
int _creating_thread_lock = 0;
slouken@0
    43
slouken@0
    44
int SDL_ThreadsInit(void)
slouken@0
    45
{
slouken@0
    46
	int retval;
slouken@0
    47
slouken@0
    48
	retval = 0;
slouken@0
    49
	/* Set the thread lock creation flag so that we can reuse an
slouken@0
    50
	   existing lock on the system - since this mutex never gets
slouken@0
    51
	   destroyed (see SDL_ThreadsQuit()), we want to reuse it.
slouken@0
    52
	*/
slouken@0
    53
	_creating_thread_lock = 1;
slouken@0
    54
	thread_lock = SDL_CreateMutex();
slouken@0
    55
	_creating_thread_lock = 0;
slouken@0
    56
	if ( thread_lock == NULL ) {
slouken@0
    57
		retval = -1;
slouken@0
    58
	}
slouken@0
    59
	return(retval);
slouken@0
    60
}
slouken@0
    61
slouken@0
    62
/* This should never be called...
slouken@0
    63
   If this is called by SDL_Quit(), we don't know whether or not we should
slouken@0
    64
   clean up threads here.  If any threads are still running after this call,
slouken@0
    65
   they will no longer have access to any per-thread data.
slouken@0
    66
 */
slouken@0
    67
void SDL_ThreadsQuit()
slouken@0
    68
{
slouken@0
    69
	SDL_mutex *mutex;
slouken@0
    70
slouken@0
    71
	mutex = thread_lock;
slouken@0
    72
	thread_lock = NULL;
slouken@0
    73
	if ( mutex != NULL ) {
slouken@0
    74
		SDL_DestroyMutex(mutex);
slouken@0
    75
	}
slouken@0
    76
}
slouken@0
    77
slouken@0
    78
/* Routines for manipulating the thread list */
slouken@0
    79
static void SDL_AddThread(SDL_Thread *thread)
slouken@0
    80
{
slouken@0
    81
	SDL_Thread **threads;
slouken@0
    82
slouken@0
    83
	/* WARNING:
slouken@0
    84
	   If the very first threads are created simultaneously, then
slouken@0
    85
	   there could be a race condition causing memory corruption.
slouken@0
    86
	   In practice, this isn't a problem because by definition there
slouken@0
    87
	   is only one thread running the first time this is called.
slouken@0
    88
	*/
slouken@0
    89
	if ( thread_lock == NULL ) {
slouken@0
    90
		if ( SDL_ThreadsInit() < 0 ) {
slouken@0
    91
			return;
slouken@0
    92
		}
slouken@0
    93
	}
slouken@0
    94
	SDL_mutexP(thread_lock);
slouken@0
    95
slouken@0
    96
	/* Expand the list of threads, if necessary */
slouken@0
    97
#ifdef DEBUG_THREADS
slouken@0
    98
	printf("Adding thread (%d already - %d max)\n",
slouken@0
    99
			SDL_numthreads, SDL_maxthreads);
slouken@0
   100
#endif
slouken@0
   101
	if ( SDL_numthreads == SDL_maxthreads ) {
slouken@1336
   102
		threads=(SDL_Thread **)SDL_malloc((SDL_maxthreads+ARRAY_CHUNKSIZE)*
slouken@0
   103
		                              (sizeof *threads));
slouken@0
   104
		if ( threads == NULL ) {
slouken@0
   105
			SDL_OutOfMemory();
slouken@0
   106
			goto done;
slouken@0
   107
		}
slouken@1336
   108
		SDL_memcpy(threads, SDL_Threads, SDL_numthreads*(sizeof *threads));
slouken@0
   109
		SDL_maxthreads += ARRAY_CHUNKSIZE;
slouken@0
   110
		if ( SDL_Threads ) {
slouken@1336
   111
			SDL_free(SDL_Threads);
slouken@0
   112
		}
slouken@0
   113
		SDL_Threads = threads;
slouken@0
   114
	}
slouken@0
   115
	SDL_Threads[SDL_numthreads++] = thread;
slouken@0
   116
done:
slouken@0
   117
	SDL_mutexV(thread_lock);
slouken@0
   118
}
slouken@0
   119
slouken@0
   120
static void SDL_DelThread(SDL_Thread *thread)
slouken@0
   121
{
slouken@0
   122
	int i;
slouken@0
   123
slouken@0
   124
	if ( thread_lock ) {
slouken@0
   125
		SDL_mutexP(thread_lock);
slouken@0
   126
		for ( i=0; i<SDL_numthreads; ++i ) {
slouken@0
   127
			if ( thread == SDL_Threads[i] ) {
slouken@0
   128
				break;
slouken@0
   129
			}
slouken@0
   130
		}
slouken@0
   131
		if ( i < SDL_numthreads ) {
slouken@340
   132
			if ( --SDL_numthreads > 0 ) {
slouken@340
   133
				while ( i < SDL_numthreads ) {
slouken@340
   134
					SDL_Threads[i] = SDL_Threads[i+1];
slouken@340
   135
					++i;
slouken@340
   136
				}
slouken@340
   137
			} else {
slouken@340
   138
				SDL_maxthreads = 0;
slouken@1336
   139
				SDL_free(SDL_Threads);
slouken@340
   140
				SDL_Threads = NULL;
slouken@0
   141
			}
slouken@0
   142
#ifdef DEBUG_THREADS
slouken@0
   143
			printf("Deleting thread (%d left - %d max)\n",
slouken@0
   144
					SDL_numthreads, SDL_maxthreads);
slouken@0
   145
#endif
slouken@0
   146
		}
slouken@0
   147
		SDL_mutexV(thread_lock);
slouken@0
   148
	}
slouken@0
   149
}
slouken@0
   150
slouken@0
   151
/* The default (non-thread-safe) global error variable */
slouken@0
   152
static SDL_error SDL_global_error;
slouken@0
   153
slouken@0
   154
/* Routine to get the thread-specific error variable */
slouken@0
   155
SDL_error *SDL_GetErrBuf(void)
slouken@0
   156
{
slouken@0
   157
	SDL_error *errbuf;
slouken@0
   158
slouken@0
   159
	errbuf = &SDL_global_error;
slouken@0
   160
	if ( SDL_Threads ) {
slouken@0
   161
		int i;
slouken@0
   162
		Uint32 this_thread;
slouken@0
   163
slouken@0
   164
		this_thread = SDL_ThreadID();
slouken@0
   165
		SDL_mutexP(thread_lock);
slouken@0
   166
		for ( i=0; i<SDL_numthreads; ++i ) {
slouken@0
   167
			if ( this_thread == SDL_Threads[i]->threadid ) {
slouken@0
   168
				errbuf = &SDL_Threads[i]->errbuf;
slouken@0
   169
				break;
slouken@0
   170
			}
slouken@0
   171
		}
slouken@0
   172
		SDL_mutexV(thread_lock);
slouken@0
   173
	}
slouken@0
   174
	return(errbuf);
slouken@0
   175
}
slouken@0
   176
slouken@0
   177
slouken@0
   178
/* Arguments and callback to setup and run the user thread function */
slouken@0
   179
typedef struct {
slouken@0
   180
	int (*func)(void *);
slouken@0
   181
	void *data;
slouken@0
   182
	SDL_Thread *info;
slouken@0
   183
	SDL_sem *wait;
slouken@0
   184
} thread_args;
slouken@0
   185
slouken@0
   186
void SDL_RunThread(void *data)
slouken@0
   187
{
slouken@0
   188
	thread_args *args;
slouken@0
   189
	int (*userfunc)(void *);
slouken@0
   190
	void *userdata;
slouken@0
   191
	int *statusloc;
slouken@0
   192
slouken@0
   193
	/* Perform any system-dependent setup
slouken@0
   194
	   - this function cannot fail, and cannot use SDL_SetError()
slouken@0
   195
	 */
slouken@0
   196
	SDL_SYS_SetupThread();
slouken@0
   197
slouken@0
   198
	/* Get the thread id */
slouken@0
   199
	args = (thread_args *)data;
slouken@0
   200
	args->info->threadid = SDL_ThreadID();
slouken@0
   201
slouken@0
   202
	/* Figure out what function to run */
slouken@0
   203
	userfunc = args->func;
slouken@0
   204
	userdata = args->data;
slouken@0
   205
	statusloc = &args->info->status;
slouken@0
   206
slouken@0
   207
	/* Wake up the parent thread */
slouken@0
   208
	SDL_SemPost(args->wait);
slouken@0
   209
slouken@0
   210
	/* Run the function */
slouken@0
   211
	*statusloc = userfunc(userdata);
slouken@0
   212
}
slouken@0
   213
slouken@1330
   214
#if defined(_WIN32) || defined(__OS2__)
slouken@1330
   215
#undef SDL_CreateThread
slouken@1330
   216
DECLSPEC SDL_Thread * SDLCALL SDL_CreateThread(int (*fn)(void *), void *data, pfnSDL_CurrentBeginThread pfnBeginThread, pfnSDL_CurrentEndThread pfnEndThread)
icculus@1190
   217
#else
icculus@1190
   218
DECLSPEC SDL_Thread * SDLCALL SDL_CreateThread(int (*fn)(void *), void *data)
icculus@1190
   219
#endif
slouken@0
   220
{
slouken@0
   221
	SDL_Thread *thread;
slouken@0
   222
	thread_args *args;
slouken@0
   223
	int ret;
slouken@0
   224
slouken@0
   225
	/* Allocate memory for the thread info structure */
slouken@1336
   226
	thread = (SDL_Thread *)SDL_malloc(sizeof(*thread));
slouken@0
   227
	if ( thread == NULL ) {
slouken@0
   228
		SDL_OutOfMemory();
slouken@0
   229
		return(NULL);
slouken@0
   230
	}
slouken@1336
   231
	SDL_memset(thread, 0, (sizeof *thread));
slouken@0
   232
	thread->status = -1;
slouken@0
   233
slouken@0
   234
	/* Set up the arguments for the thread */
slouken@1336
   235
	args = (thread_args *)SDL_malloc(sizeof(*args));
slouken@0
   236
	if ( args == NULL ) {
slouken@0
   237
		SDL_OutOfMemory();
slouken@1336
   238
		SDL_free(thread);
slouken@0
   239
		return(NULL);
slouken@0
   240
	}
slouken@0
   241
	args->func = fn;
slouken@0
   242
	args->data = data;
slouken@0
   243
	args->info = thread;
slouken@0
   244
	args->wait = SDL_CreateSemaphore(0);
slouken@0
   245
	if ( args->wait == NULL ) {
slouken@1336
   246
		SDL_free(thread);
slouken@1336
   247
		SDL_free(args);
slouken@0
   248
		return(NULL);
slouken@0
   249
	}
slouken@0
   250
slouken@0
   251
	/* Add the thread to the list of available threads */
slouken@0
   252
	SDL_AddThread(thread);
slouken@0
   253
slouken@0
   254
	/* Create the thread and go! */
slouken@1330
   255
#if defined(_WIN32) || defined(__OS2__)
slouken@1330
   256
	ret = SDL_SYS_CreateThread(thread, args, pfnBeginThread, pfnEndThread);
icculus@1190
   257
#else
slouken@0
   258
	ret = SDL_SYS_CreateThread(thread, args);
icculus@1190
   259
#endif
slouken@0
   260
	if ( ret >= 0 ) {
slouken@0
   261
		/* Wait for the thread function to use arguments */
slouken@0
   262
		SDL_SemWait(args->wait);
slouken@0
   263
	} else {
slouken@0
   264
		/* Oops, failed.  Gotta free everything */
slouken@0
   265
		SDL_DelThread(thread);
slouken@1336
   266
		SDL_free(thread);
slouken@0
   267
		thread = NULL;
slouken@0
   268
	}
slouken@0
   269
	SDL_DestroySemaphore(args->wait);
slouken@1336
   270
	SDL_free(args);
slouken@0
   271
slouken@0
   272
	/* Everything is running now */
slouken@0
   273
	return(thread);
slouken@0
   274
}
slouken@0
   275
slouken@0
   276
void SDL_WaitThread(SDL_Thread *thread, int *status)
slouken@0
   277
{
slouken@0
   278
	if ( thread ) {
slouken@0
   279
		SDL_SYS_WaitThread(thread);
slouken@0
   280
		if ( status ) {
slouken@0
   281
			*status = thread->status;
slouken@0
   282
		}
slouken@0
   283
		SDL_DelThread(thread);
slouken@1336
   284
		SDL_free(thread);
slouken@0
   285
	}
slouken@0
   286
}
slouken@0
   287
slouken@0
   288
Uint32 SDL_GetThreadID(SDL_Thread *thread)
slouken@0
   289
{
slouken@0
   290
	Uint32 id;
slouken@0
   291
slouken@0
   292
	if ( thread ) {
slouken@0
   293
		id = thread->threadid;
slouken@0
   294
	} else {
slouken@0
   295
		id = SDL_ThreadID();
slouken@0
   296
	}
slouken@0
   297
	return(id);
slouken@0
   298
}
slouken@0
   299
slouken@0
   300
void SDL_KillThread(SDL_Thread *thread)
slouken@0
   301
{
slouken@0
   302
	if ( thread ) {
slouken@0
   303
		SDL_SYS_KillThread(thread);
slouken@0
   304
		SDL_WaitThread(thread, NULL);
slouken@0
   305
	}
slouken@0
   306
}
slouken@0
   307