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