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