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