blob: e881e05dce5cc85c4f90a23eda751d8c58d99e8d [file] [log] [blame]
/*
* Win32 threads
*
* Copyright 1996 Alexandre Julliard
*/
#include <assert.h>
#include <signal.h>
#include <unistd.h>
#include "thread.h"
#include "process.h"
#include "winerror.h"
#include "heap.h"
#include "selectors.h"
#include "miscemu.h"
#include "winnt.h"
#include "server.h"
#include "debug.h"
#ifndef __i386__
THDB *pCurrentThread;
#endif
static BOOL32 THREAD_Signaled( K32OBJ *obj, DWORD thread_id );
static BOOL32 THREAD_Satisfied( K32OBJ *obj, DWORD thread_id );
static void THREAD_AddWait( K32OBJ *obj, DWORD thread_id );
static void THREAD_RemoveWait( K32OBJ *obj, DWORD thread_id );
static void THREAD_Destroy( K32OBJ *obj );
const K32OBJ_OPS THREAD_Ops =
{
THREAD_Signaled, /* signaled */
THREAD_Satisfied, /* satisfied */
THREAD_AddWait, /* add_wait */
THREAD_RemoveWait, /* remove_wait */
NULL, /* read */
NULL, /* write */
THREAD_Destroy /* destroy */
};
/* The pseudohandle used for the current thread, see GetCurrentThread */
#define CURRENT_THREAD_PSEUDOHANDLE 0xfffffffe
/* Is threading code initialized? */
BOOL32 THREAD_InitDone = FALSE;
/**********************************************************************
* THREAD_GetPtr
*
* Return a pointer to a thread object. The object count must be decremented
* when no longer used.
*/
THDB *THREAD_GetPtr( HANDLE32 handle, DWORD access )
{
THDB *thread;
if (handle == CURRENT_THREAD_PSEUDOHANDLE) /* Self-thread handle */
{
thread = THREAD_Current();
K32OBJ_IncCount( &thread->header );
}
else thread = (THDB *)HANDLE_GetObjPtr( PROCESS_Current(), handle,
K32OBJ_THREAD, access );
return thread;
}
/***********************************************************************
* THREAD_Current
*
* Return the current thread THDB pointer.
*/
THDB *THREAD_Current(void)
{
if (!THREAD_InitDone) return NULL;
return (THDB *)((char *)NtCurrentTeb() - (int)&((THDB *)0)->teb);
}
/***********************************************************************
* THREAD_AddQueue
*
* Add a thread to a queue.
*/
void THREAD_AddQueue( THREAD_QUEUE *queue, THDB *thread )
{
THREAD_ENTRY *entry = HeapAlloc( SystemHeap, HEAP_NO_SERIALIZE,
sizeof(*entry) );
assert(entry);
SYSTEM_LOCK();
entry->thread = thread;
if (*queue)
{
entry->next = (*queue)->next;
(*queue)->next = entry;
}
else entry->next = entry;
*queue = entry;
SYSTEM_UNLOCK();
}
/***********************************************************************
* THREAD_RemoveQueue
*
* Remove a thread from a queue.
*/
void THREAD_RemoveQueue( THREAD_QUEUE *queue, THDB *thread )
{
THREAD_ENTRY *entry = *queue;
SYSTEM_LOCK();
if (entry->next == entry) /* Only one element in the queue */
{
assert( entry->thread == thread );
*queue = NULL;
}
else
{
THREAD_ENTRY *next;
while (entry->next->thread != thread)
{
entry = entry->next;
assert( entry != *queue ); /* Have we come all the way around? */
}
if ((next = entry->next) == *queue) *queue = entry;
entry->next = entry->next->next;
entry = next; /* This is the one we want to free */
}
HeapFree( SystemHeap, 0, entry );
SYSTEM_UNLOCK();
}
/***********************************************************************
* THREAD_Create
*/
THDB *THREAD_Create( PDB32 *pdb, DWORD stack_size, BOOL32 alloc_stack16,
LPTHREAD_START_ROUTINE start_addr, LPVOID param )
{
DWORD old_prot;
WORD cs, ds;
THDB *thdb = HeapAlloc( SystemHeap, HEAP_ZERO_MEMORY, sizeof(THDB) );
if (!thdb) return NULL;
thdb->header.type = K32OBJ_THREAD;
thdb->header.refcount = 1;
thdb->process = pdb;
thdb->teb.except = (void *)-1;
thdb->teb.htask16 = 0; /* FIXME */
thdb->teb.self = &thdb->teb;
thdb->teb.tls_ptr = thdb->tls_array;
thdb->teb.process = pdb;
thdb->wait_list = &thdb->wait_struct;
thdb->exit_code = 0x103; /* STILL_ACTIVE */
thdb->entry_point = start_addr;
thdb->entry_arg = param;
thdb->socket = -1;
/* Allocate the stack */
/* FIXME:
* If stacksize smaller than 1 MB, allocate 1MB
* (one program wanted only 10 kB, which is recommendable, but some WINE
* functions, noteably in the files subdir, push HUGE structures and
* arrays on the stack. They probably shouldn't.)
* If stacksize larger than 16 MB, warn the user. (We could shrink the stack
* but this could give more or less unexplainable crashes.)
*/
if (stack_size<1024*1024)
stack_size = 1024 * 1024;
if (stack_size >= 16*1024*1024)
WARN(thread,"Thread stack size is %ld MB.\n",stack_size/1024/1024);
thdb->stack_base = VirtualAlloc(NULL,
stack_size + (alloc_stack16 ? 0x10000 : 0),
MEM_COMMIT, PAGE_EXECUTE_READWRITE );
if (!thdb->stack_base) goto error;
/* Set a guard page at the bottom of the stack */
VirtualProtect( thdb->stack_base, 1, PAGE_EXECUTE_READWRITE | PAGE_GUARD,
&old_prot );
thdb->teb.stack_top = (char *)thdb->stack_base + stack_size;
thdb->teb.stack_low = thdb->stack_base;
thdb->exit_stack = thdb->teb.stack_top;
/* Allocate the TEB selector (%fs register) */
thdb->teb_sel = SELECTOR_AllocBlock( &thdb->teb, 0x1000, SEGMENT_DATA,
TRUE, FALSE );
if (!thdb->teb_sel) goto error;
/* Allocate the 16-bit stack selector */
if (alloc_stack16)
{
thdb->teb.stack_sel = SELECTOR_AllocBlock( thdb->teb.stack_top,
0x10000, SEGMENT_DATA,
FALSE, FALSE );
if (!thdb->teb.stack_sel) goto error;
thdb->cur_stack = PTR_SEG_OFF_TO_SEGPTR( thdb->teb.stack_sel, 0xfffc );
}
/* Allocate the event */
if (!(thdb->event = EVENT_Create( TRUE, FALSE ))) goto error;
/* Create the thread socket */
if (CLIENT_NewThread( thdb )) goto error;
/* Initialize the thread context */
GET_CS(cs);
GET_DS(ds);
thdb->pcontext = &thdb->context;
thdb->context.SegCs = cs;
thdb->context.SegDs = ds;
thdb->context.SegEs = ds;
thdb->context.SegGs = ds;
thdb->context.SegSs = ds;
thdb->context.SegFs = thdb->teb_sel;
thdb->context.Eip = (DWORD)start_addr;
thdb->context.Esp = (DWORD)thdb->teb.stack_top;
PE_InitTls( thdb );
return thdb;
error:
if (thdb->socket != -1) close( thdb->socket );
if (thdb->event) K32OBJ_DecCount( thdb->event );
if (thdb->teb.stack_sel) SELECTOR_FreeBlock( thdb->teb.stack_sel, 1 );
if (thdb->teb_sel) SELECTOR_FreeBlock( thdb->teb_sel, 1 );
if (thdb->stack_base) VirtualFree( thdb->stack_base, 0, MEM_RELEASE );
HeapFree( SystemHeap, 0, thdb );
return NULL;
}
/***********************************************************************
* THREAD_Signaled
*/
static BOOL32 THREAD_Signaled( K32OBJ *obj, DWORD thread_id )
{
THDB *thdb = (THDB *)obj;
assert( obj->type == K32OBJ_THREAD );
return K32OBJ_OPS( thdb->event )->signaled( thdb->event, thread_id );
}
/***********************************************************************
* THREAD_Satisfied
*
* Wait on this object has been satisfied.
*/
static BOOL32 THREAD_Satisfied( K32OBJ *obj, DWORD thread_id )
{
THDB *thdb = (THDB *)obj;
assert( obj->type == K32OBJ_THREAD );
return K32OBJ_OPS( thdb->event )->satisfied( thdb->event, thread_id );
}
/***********************************************************************
* THREAD_AddWait
*
* Add thread to object wait queue.
*/
static void THREAD_AddWait( K32OBJ *obj, DWORD thread_id )
{
THDB *thdb = (THDB *)obj;
assert( obj->type == K32OBJ_THREAD );
return K32OBJ_OPS( thdb->event )->add_wait( thdb->event, thread_id );
}
/***********************************************************************
* THREAD_RemoveWait
*
* Remove thread from object wait queue.
*/
static void THREAD_RemoveWait( K32OBJ *obj, DWORD thread_id )
{
THDB *thdb = (THDB *)obj;
assert( obj->type == K32OBJ_THREAD );
return K32OBJ_OPS( thdb->event )->remove_wait( thdb->event, thread_id );
}
/***********************************************************************
* THREAD_Destroy
*/
static void THREAD_Destroy( K32OBJ *ptr )
{
THDB *thdb = (THDB *)ptr;
assert( ptr->type == K32OBJ_THREAD );
ptr->type = K32OBJ_UNKNOWN;
/* Free the associated memory */
#ifdef __i386__
{
/* Check if we are deleting the current thread */
WORD fs;
GET_FS( fs );
if (fs == thdb->teb_sel)
{
GET_DS( fs );
SET_FS( fs );
}
}
#endif
close( thdb->socket );
K32OBJ_DecCount( thdb->event );
SELECTOR_FreeBlock( thdb->teb_sel, 1 );
if (thdb->teb.stack_sel) SELECTOR_FreeBlock( thdb->teb.stack_sel, 1 );
HeapFree( SystemHeap, 0, thdb );
}
/***********************************************************************
* CreateThread (KERNEL32.63)
*/
HANDLE32 WINAPI CreateThread( SECURITY_ATTRIBUTES *sa, DWORD stack,
LPTHREAD_START_ROUTINE start, LPVOID param,
DWORD flags, LPDWORD id )
{
HANDLE32 handle = INVALID_HANDLE_VALUE32;
BOOL32 inherit = (sa && (sa->nLength>=sizeof(*sa)) && sa->bInheritHandle);
THDB *thread = THREAD_Create( PROCESS_Current(), stack,
TRUE, start, param );
if (!thread) return INVALID_HANDLE_VALUE32;
handle = HANDLE_Alloc( PROCESS_Current(), &thread->header,
THREAD_ALL_ACCESS, inherit );
if (handle == INVALID_HANDLE_VALUE32) goto error;
if (SYSDEPS_SpawnThread( thread ) == -1) goto error;
*id = THDB_TO_THREAD_ID( thread );
return handle;
error:
if (handle != INVALID_HANDLE_VALUE32) CloseHandle( handle );
K32OBJ_DecCount( &thread->header );
return INVALID_HANDLE_VALUE32;
}
/***********************************************************************
* ExitThread [KERNEL32.215] Ends a thread
*
* RETURNS
* None
*/
void WINAPI ExitThread(
DWORD code) /* [in] Exit code for this thread */
{
THDB *thdb = THREAD_Current();
LONG count;
SYSTEM_LOCK();
thdb->exit_code = code;
EVENT_Set( thdb->event );
/* Abandon all owned mutexes */
while (thdb->mutex_list) MUTEX_Abandon( thdb->mutex_list );
/* FIXME: should free the stack somehow */
#if 0
/* FIXME: We cannot do this; once the current thread is destroyed,
synchronization primitives do not work properly. */
K32OBJ_DecCount( &thdb->header );
#endif
/* Completely unlock the system lock just in case */
count = SYSTEM_LOCK_COUNT();
while (count--) SYSTEM_UNLOCK();
SYSDEPS_ExitThread();
}
/***********************************************************************
* GetCurrentThread [KERNEL32.200] Gets pseudohandle for current thread
*
* RETURNS
* Pseudohandle for the current thread
*/
HANDLE32 WINAPI GetCurrentThread(void)
{
return CURRENT_THREAD_PSEUDOHANDLE;
}
/***********************************************************************
* GetCurrentThreadId [KERNEL32.201] Returns thread identifier.
*
* RETURNS
* Thread identifier of calling thread
*/
DWORD WINAPI GetCurrentThreadId(void)
{
return THDB_TO_THREAD_ID( THREAD_Current() );
}
/**********************************************************************
* GetLastError [KERNEL.148] [KERNEL32.227] Returns last-error code.
*
* RETURNS
* Calling thread's last error code value.
*/
DWORD WINAPI GetLastError(void)
{
THDB *thread = THREAD_Current();
return thread->last_error;
}
/**********************************************************************
* SetLastError [KERNEL.147] [KERNEL32.497] Sets the last-error code.
*
* RETURNS
* None.
*/
void WINAPI SetLastError(
DWORD error) /* [in] Per-thread error code */
{
THDB *thread = THREAD_Current();
/* This one must work before we have a thread (FIXME) */
if (thread) thread->last_error = error;
}
/**********************************************************************
* SetLastErrorEx [USER32.485] Sets the last-error code.
*
* RETURNS
* None.
*/
void WINAPI SetLastErrorEx(
DWORD error, /* [in] Per-thread error code */
DWORD type) /* [in] Error type */
{
TRACE(thread, "(%08lx, %08lx)\n", error,type);
switch(type) {
case 0:
break;
case SLE_ERROR:
case SLE_MINORERROR:
case SLE_WARNING:
/* Fall through for now */
default:
FIXME(thread, "(error=%08lx, type=%08lx): Unhandled type\n", error,type);
break;
}
SetLastError( error );
}
/**********************************************************************
* THREAD_TlsAlloc
*/
DWORD THREAD_TlsAlloc(THDB *thread)
{
DWORD i, mask, ret = 0;
DWORD *bits = thread->process->tls_bits;
EnterCriticalSection( &thread->process->crit_section );
if (*bits == 0xffffffff)
{
bits++;
ret = 32;
if (*bits == 0xffffffff)
{
LeaveCriticalSection( &thread->process->crit_section );
SetLastError( ERROR_NO_MORE_ITEMS );
return 0xffffffff;
}
}
for (i = 0, mask = 1; i < 32; i++, mask <<= 1) if (!(*bits & mask)) break;
*bits |= mask;
LeaveCriticalSection( &thread->process->crit_section );
return ret + i;
}
/**********************************************************************
* TlsAlloc [KERNEL32.530] Allocates a TLS index.
*
* Allocates a thread local storage index
*
* RETURNS
* Success: TLS Index
* Failure: 0xFFFFFFFF
*/
DWORD WINAPI TlsAlloc(void)
{
return THREAD_TlsAlloc(THREAD_Current());
}
/**********************************************************************
* TlsFree [KERNEL32.531] Releases a TLS index.
*
* Releases a thread local storage index, making it available for reuse
*
* RETURNS
* Success: TRUE
* Failure: FALSE
*/
BOOL32 WINAPI TlsFree(
DWORD index) /* [in] TLS Index to free */
{
DWORD mask;
THDB *thread = THREAD_Current();
DWORD *bits = thread->process->tls_bits;
if (index >= 64)
{
SetLastError( ERROR_INVALID_PARAMETER );
return FALSE;
}
EnterCriticalSection( &thread->process->crit_section );
if (index >= 32) bits++;
mask = (1 << (index & 31));
if (!(*bits & mask)) /* already free? */
{
LeaveCriticalSection( &thread->process->crit_section );
SetLastError( ERROR_INVALID_PARAMETER );
return FALSE;
}
*bits &= ~mask;
thread->tls_array[index] = 0;
/* FIXME: should zero all other thread values */
LeaveCriticalSection( &thread->process->crit_section );
return TRUE;
}
/**********************************************************************
* TlsGetValue [KERNEL32.532] Gets value in a thread's TLS slot
*
* RETURNS
* Success: Value stored in calling thread's TLS slot for index
* Failure: 0 and GetLastError returns NO_ERROR
*/
LPVOID WINAPI TlsGetValue(
DWORD index) /* [in] TLS index to retrieve value for */
{
THDB *thread = THREAD_Current();
if (index >= 64)
{
SetLastError( ERROR_INVALID_PARAMETER );
return NULL;
}
SetLastError( ERROR_SUCCESS );
return thread->tls_array[index];
}
/**********************************************************************
* TlsSetValue [KERNEL32.533] Stores a value in the thread's TLS slot.
*
* RETURNS
* Success: TRUE
* Failure: FALSE
*/
BOOL32 WINAPI TlsSetValue(
DWORD index, /* [in] TLS index to set value for */
LPVOID value) /* [in] Value to be stored */
{
THDB *thread = THREAD_Current();
if (index >= 64)
{
SetLastError( ERROR_INVALID_PARAMETER );
return FALSE;
}
thread->tls_array[index] = value;
return TRUE;
}
/***********************************************************************
* SetThreadContext [KERNEL32.670] Sets context of thread.
*
* RETURNS
* Success: TRUE
* Failure: FALSE
*/
BOOL32 WINAPI SetThreadContext(
HANDLE32 handle, /* [in] Handle to thread with context */
CONTEXT *context) /* [out] Address of context structure */
{
THDB *thread = THREAD_GetPtr( handle, THREAD_GET_CONTEXT );
if (!thread) return FALSE;
*context = thread->context;
K32OBJ_DecCount( &thread->header );
return TRUE;
}
/***********************************************************************
* GetThreadContext [KERNEL32.294] Retrieves context of thread.
*
* RETURNS
* Success: TRUE
* Failure: FALSE
*/
BOOL32 WINAPI GetThreadContext(
HANDLE32 handle, /* [in] Handle to thread with context */
CONTEXT *context) /* [out] Address of context structure */
{
THDB *thread = THREAD_GetPtr( handle, THREAD_GET_CONTEXT );
if (!thread) return FALSE;
*context = thread->context;
K32OBJ_DecCount( &thread->header );
return TRUE;
}
/**********************************************************************
* GetThreadPriority [KERNEL32.296] Returns priority for thread.
*
* RETURNS
* Success: Thread's priority level.
* Failure: THREAD_PRIORITY_ERROR_RETURN
*/
INT32 WINAPI GetThreadPriority(
HANDLE32 hthread) /* [in] Handle to thread */
{
THDB *thread;
INT32 ret;
if (!(thread = THREAD_GetPtr( hthread, THREAD_QUERY_INFORMATION )))
return THREAD_PRIORITY_ERROR_RETURN;
ret = thread->delta_priority;
K32OBJ_DecCount( &thread->header );
return ret;
}
/**********************************************************************
* SetThreadPriority [KERNEL32.514] Sets priority for thread.
*
* RETURNS
* Success: TRUE
* Failure: FALSE
*/
BOOL32 WINAPI SetThreadPriority(
HANDLE32 hthread, /* [in] Handle to thread */
INT32 priority) /* [in] Thread priority level */
{
THDB *thread;
if (!(thread = THREAD_GetPtr( hthread, THREAD_SET_INFORMATION )))
return FALSE;
thread->delta_priority = priority;
K32OBJ_DecCount( &thread->header );
return TRUE;
}
/**********************************************************************
* TerminateThread [KERNEL32.???] Terminates a thread
*
* RETURNS
* Success: TRUE
* Failure: FALSE
*/
BOOL32 WINAPI TerminateThread(
HANDLE32 handle, /* [in] Handle to thread */
DWORD exitcode) /* [in] Exit code for thread */
{
FIXME(thread,"(0x%08x,%ld): stub\n",handle,exitcode);
SetLastError(ERROR_CALL_NOT_IMPLEMENTED);
return TRUE;
}
/**********************************************************************
* GetExitCodeThread [KERNEL32.???] Gets termination status of thread.
*
* RETURNS
* Success: TRUE
* Failure: FALSE
*/
BOOL32 WINAPI GetExitCodeThread(
HANDLE32 hthread, /* [in] Handle to thread */
LPDWORD exitcode) /* [out] Address to receive termination status */
{
THDB *thread;
if (!(thread = THREAD_GetPtr( hthread, THREAD_QUERY_INFORMATION )))
return FALSE;
if (exitcode) *exitcode = thread->exit_code;
K32OBJ_DecCount( &thread->header );
return TRUE;
}
/**********************************************************************
* ResumeThread [KERNEL32.587] Resumes a thread.
*
* Decrements a thread's suspend count. When count is zero, the
* execution of the thread is resumed.
*
* RETURNS
* Success: Previous suspend count
* Failure: 0xFFFFFFFF
* Already running: 0
*/
DWORD WINAPI ResumeThread(
HANDLE32 hthread) /* [in] Indentifies thread to restart */
{
THDB *thread;
DWORD oldcount;
SYSTEM_LOCK();
if (!(thread = THREAD_GetPtr( hthread, THREAD_QUERY_INFORMATION )))
{
SYSTEM_UNLOCK();
WARN(thread, "Invalid thread handle\n");
return 0xFFFFFFFF;
}
if ((oldcount = thread->suspend_count) != 0)
{
if (!--thread->suspend_count)
{
if (kill(thread->unix_pid, SIGCONT))
{
WARN(thread, "Unable to CONTinue pid: %04x\n",
thread->unix_pid);
oldcount = 0xFFFFFFFF;
}
}
}
K32OBJ_DecCount(&thread->header);
SYSTEM_UNLOCK();
return oldcount;
}
/**********************************************************************
* SuspendThread [KERNEL32.681] Suspends a thread.
*
* RETURNS
* Success: Previous suspend count
* Failure: 0xFFFFFFFF
*/
DWORD WINAPI SuspendThread(
HANDLE32 hthread) /* [in] Handle to the thread */
{
THDB *thread;
DWORD oldcount;
SYSTEM_LOCK();
if (!(thread = THREAD_GetPtr( hthread, THREAD_QUERY_INFORMATION )))
{
SYSTEM_UNLOCK();
WARN(thread, "Invalid thread handle\n");
return 0xFFFFFFFF;
}
if (!(oldcount = thread->suspend_count))
{
if (thread->unix_pid == getpid())
WARN(thread, "Attempting to suspend myself\n" );
else
{
if (kill(thread->unix_pid, SIGSTOP))
{
WARN(thread, "Unable to STOP pid: %04x\n",
thread->unix_pid);
oldcount = 0xFFFFFFFF;
}
else thread->suspend_count++;
}
}
else thread->suspend_count++;
K32OBJ_DecCount( &thread->header );
SYSTEM_UNLOCK();
return oldcount;
}
/**********************************************************************
* GetThreadTimes [KERNEL32.???] Obtains timing information.
*
* NOTES
* What are the fields where these values are stored?
*
* RETURNS
* Success: TRUE
* Failure: FALSE
*/
BOOL32 WINAPI GetThreadTimes(
HANDLE32 thread, /* [in] Specifies the thread of interest */
LPFILETIME creationtime, /* [out] When the thread was created */
LPFILETIME exittime, /* [out] When the thread was destroyed */
LPFILETIME kerneltime, /* [out] Time thread spent in kernel mode */
LPFILETIME usertime) /* [out] Time thread spent in user mode */
{
FIXME(thread,"(0x%08x): stub\n",thread);
SetLastError(ERROR_CALL_NOT_IMPLEMENTED);
return FALSE;
}
/**********************************************************************
* AttachThreadInput [KERNEL32.8] Attaches input of 1 thread to other
*
* Attaches the input processing mechanism of one thread to that of
* another thread.
*
* RETURNS
* Success: TRUE
* Failure: FALSE
*/
BOOL32 WINAPI AttachThreadInput(
DWORD idAttach, /* [in] Thread to attach */
DWORD idAttachTo, /* [in] Thread to attach to */
BOOL32 fAttach) /* [in] Attach or detach */
{
BOOL32 ret;
FIXME(thread, "(0x%08lx,0x%08lx,%d): stub\n",idAttach,idAttachTo,fAttach);
SetLastError(ERROR_CALL_NOT_IMPLEMENTED);
if (fAttach) {
/* Attach threads */
ret = FALSE;
}
else {
/* Detach threads */
ret = FALSE;
};
return ret;
}