dlls/ntdll/thread.c

   1 /*
   2  * NT threads support
   3  *
   4  * Copyright 1996, 2003 Alexandre Julliard
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  */
  20
  21 #include <assert.h>
  22 #include <stdarg.h>
  23 #include <limits.h>
  24 #include <sys/types.h>
  25
  26 #define NONAMELESSUNION
  27 #include "ntstatus.h"
  28 #define WIN32_NO_STATUS
  29 #include "winternl.h"
  30 #include "wine/server.h"
  31 #include "wine/debug.h"
  32 #include "ntdll_misc.h"
  33 #include "ddk/wdm.h"
  34 #include "wine/exception.h"
  35
  36 WINE_DECLARE_DEBUG_CHANNEL(relay);
  37 WINE_DECLARE_DEBUG_CHANNEL(thread);
  38
  39 struct _KUSER_SHARED_DATA *user_shared_data = (void *)0x7ffe0000;
  40
  41
  42 /***********************************************************************
  43  *              __wine_dbg_get_channel_flags  (NTDLL.@)
  44  *
  45  * Get the flags to use for a given channel, possibly setting them too in case of lazy init
  46  */
  47 unsigned char __cdecl __wine_dbg_get_channel_flags( struct __wine_debug_channel *channel )
  48 {
  49     return unix_funcs->dbg_get_channel_flags( channel );
  50 }
  51
  52 /***********************************************************************
  53  *              __wine_dbg_strdup  (NTDLL.@)
  54  */
  55 const char * __cdecl __wine_dbg_strdup( const char *str )
  56 {
  57     return unix_funcs->dbg_strdup( str );
  58 }
  59
  60 /***********************************************************************
  61  *              __wine_dbg_header  (NTDLL.@)
  62  */
  63 int __cdecl __wine_dbg_header( enum __wine_debug_class cls, struct __wine_debug_channel *channel,
  64                                const char *function )
  65 {
  66     return unix_funcs->dbg_header( cls, channel, function );
  67 }
  68
  69 /***********************************************************************
  70  *              __wine_dbg_output  (NTDLL.@)
  71  */
  72 int __cdecl __wine_dbg_output( const char *str )
  73 {
  74     return unix_funcs->dbg_output( str );
  75 }
  76
  77
  78 /***********************************************************************
  79  *           RtlExitUserThread  (NTDLL.@)
  80  */
  81 void WINAPI RtlExitUserThread( ULONG status )
  82 {
  83     ULONG last;
  84
  85     NtQueryInformationThread( GetCurrentThread(), ThreadAmILastThread, &last, sizeof(last), NULL );
  86     if (last) RtlExitUserProcess( status );
  87     LdrShutdownThread();
  88     RtlFreeThreadActivationContextStack();
  89     for (;;) NtTerminateThread( GetCurrentThread(), status );
  90 }
  91
  92
  93 /***********************************************************************
  94  *           RtlUserThreadStart (NTDLL.@)
  95  */
  96 #ifdef __i386__
  97 __ASM_STDCALL_FUNC( RtlUserThreadStart, 8,
  98                    "movl %ebx,8(%esp)\n\t"  /* arg */
  99                    "movl %eax,4(%esp)\n\t"  /* entry */
 100                    "jmp " __ASM_NAME("call_thread_func") )
 101
 102 /* wrapper to call BaseThreadInitThunk */
 103 extern void DECLSPEC_NORETURN call_thread_func_wrapper( void *thunk, PRTL_THREAD_START_ROUTINE entry, void *arg );
 104 __ASM_GLOBAL_FUNC( call_thread_func_wrapper,
 105                   "pushl %ebp\n\t"
 106                   __ASM_CFI(".cfi_adjust_cfa_offset 4\n\t")
 107                   __ASM_CFI(".cfi_rel_offset %ebp,0\n\t")
 108                   "movl %esp,%ebp\n\t"
 109                   __ASM_CFI(".cfi_def_cfa_register %ebp\n\t")
 110                    "subl $4,%esp\n\t"
 111                    "andl $~0xf,%esp\n\t"
 112                    "xorl %ecx,%ecx\n\t"
 113                    "movl 12(%ebp),%edx\n\t"
 114                    "movl 16(%ebp),%eax\n\t"
 115                    "movl %eax,(%esp)\n\t"
 116                    "call *8(%ebp)" )
 117
 118 void DECLSPEC_HIDDEN call_thread_func( PRTL_THREAD_START_ROUTINE entry, void *arg )
 119 {
 120     __TRY
 121     {
 122         TRACE_(relay)( "\1Starting thread proc %p (arg=%p)\n", entry, arg );
 123         call_thread_func_wrapper( pBaseThreadInitThunk, entry, arg );
 124     }
 125     __EXCEPT(call_unhandled_exception_filter)
 126     {
 127         NtTerminateProcess( GetCurrentProcess(), GetExceptionCode() );
 128     }
 129     __ENDTRY
 130 }
 131
 132 #else  /* __i386__ */
 133
 134 void WINAPI RtlUserThreadStart( PRTL_THREAD_START_ROUTINE entry, void *arg )
 135 {
 136     __TRY
 137     {
 138         TRACE_(relay)( "\1Starting thread proc %p (arg=%p)\n", entry, arg );
 139         pBaseThreadInitThunk( 0, (LPTHREAD_START_ROUTINE)entry, arg );
 140     }
 141     __EXCEPT(call_unhandled_exception_filter)
 142     {
 143         NtTerminateProcess( GetCurrentProcess(), GetExceptionCode() );
 144     }
 145     __ENDTRY
 146 }
 147
 148 #endif  /* __i386__ */
 149
 150
 151 /***********************************************************************
 152  *              RtlCreateUserThread   (NTDLL.@)
 153  */
 154 NTSTATUS WINAPI RtlCreateUserThread( HANDLE process, SECURITY_DESCRIPTOR *descr,
 155                                      BOOLEAN suspended, PVOID stack_addr,
 156                                      SIZE_T stack_reserve, SIZE_T stack_commit,
 157                                      PRTL_THREAD_START_ROUTINE start, void *param,
 158                                      HANDLE *handle_ptr, CLIENT_ID *id )
 159 {
 160     ULONG flags = suspended ? THREAD_CREATE_FLAGS_CREATE_SUSPENDED : 0;
 161     ULONG_PTR buffer[offsetof( PS_ATTRIBUTE_LIST, Attributes[2] ) / sizeof(ULONG_PTR)];
 162     PS_ATTRIBUTE_LIST *attr_list = (PS_ATTRIBUTE_LIST *)buffer;
 163     HANDLE handle, actctx;
 164     TEB *teb;
 165     ULONG ret;
 166     NTSTATUS status;
 167     CLIENT_ID client_id;
 168     OBJECT_ATTRIBUTES attr;
 169
 170     attr_list->TotalLength = sizeof(buffer);
 171     attr_list->Attributes[0].Attribute    = PS_ATTRIBUTE_CLIENT_ID;
 172     attr_list->Attributes[0].Size         = sizeof(client_id);
 173     attr_list->Attributes[0].ValuePtr     = &client_id;
 174     attr_list->Attributes[0].ReturnLength = NULL;
 175     attr_list->Attributes[1].Attribute    = PS_ATTRIBUTE_TEB_ADDRESS;
 176     attr_list->Attributes[1].Size         = sizeof(teb);
 177     attr_list->Attributes[1].ValuePtr     = &teb;
 178     attr_list->Attributes[1].ReturnLength = NULL;
 179
 180     InitializeObjectAttributes( &attr, NULL, 0, NULL, descr );
 181
 182     RtlGetActiveActivationContext( &actctx );
 183     if (actctx) flags |= THREAD_CREATE_FLAGS_CREATE_SUSPENDED;
 184
 185     status = NtCreateThreadEx( &handle, THREAD_ALL_ACCESS, &attr, process, start, param,
 186                                flags, 0, stack_commit, stack_reserve, attr_list );
 187     if (!status)
 188     {
 189         if (actctx)
 190         {
 191             ULONG_PTR cookie;
 192             RtlActivateActivationContextEx( 0, teb, actctx, &cookie );
 193             if (!suspended) NtResumeThread( handle, &ret );
 194         }
 195         if (id) *id = client_id;
 196         if (handle_ptr) *handle_ptr = handle;
 197         else NtClose( handle );
 198     }
 199     if (actctx) RtlReleaseActivationContext( actctx );
 200     return status;
 201 }
 202
 203
 204 /******************************************************************************
 205  *              RtlGetNtGlobalFlags   (NTDLL.@)
 206  */
 207 ULONG WINAPI RtlGetNtGlobalFlags(void)
 208 {
 209     return NtCurrentTeb()->Peb->NtGlobalFlag;
 210 }
 211
 212
 213 /******************************************************************************
 214  *              RtlPushFrame  (NTDLL.@)
 215  */
 216 void WINAPI RtlPushFrame( TEB_ACTIVE_FRAME *frame )
 217 {
 218     frame->Previous = NtCurrentTeb()->ActiveFrame;
 219     NtCurrentTeb()->ActiveFrame = frame;
 220 }
 221
 222
 223 /******************************************************************************
 224  *              RtlPopFrame  (NTDLL.@)
 225  */
 226 void WINAPI RtlPopFrame( TEB_ACTIVE_FRAME *frame )
 227 {
 228     NtCurrentTeb()->ActiveFrame = frame->Previous;
 229 }
 230
 231
 232 /******************************************************************************
 233  *              RtlGetFrame  (NTDLL.@)
 234  */
 235 TEB_ACTIVE_FRAME * WINAPI RtlGetFrame(void)
 236 {
 237     return NtCurrentTeb()->ActiveFrame;
 238 }
 239
 240
 241 /***********************************************************************
 242  * Fibers
 243  ***********************************************************************/
 244
 245
 246 static GLOBAL_FLS_DATA fls_data;
 247
 248 static RTL_CRITICAL_SECTION fls_section;
 249 static RTL_CRITICAL_SECTION_DEBUG fls_critsect_debug =
 250 {
 251     0, 0, &fls_section,
 252     { &fls_critsect_debug.ProcessLocksList, &fls_critsect_debug.ProcessLocksList },
 253             0, 0, { (DWORD_PTR)(__FILE__ ": fls_section") }
 254 };
 255 static RTL_CRITICAL_SECTION fls_section = { &fls_critsect_debug, -1, 0, 0, 0, 0 };
 256
 257 #define MAX_FLS_DATA_COUNT 0xff0
 258
 259 void init_global_fls_data(void)
 260 {
 261     InitializeListHead( &fls_data.fls_list_head );
 262 }
 263
 264 static void lock_fls_data(void)
 265 {
 266     RtlEnterCriticalSection( &fls_section );
 267 }
 268
 269 static void unlock_fls_data(void)
 270 {
 271     RtlLeaveCriticalSection( &fls_section );
 272 }
 273
 274 static unsigned int fls_chunk_size( unsigned int chunk_index )
 275 {
 276     return 0x10 << chunk_index;
 277 }
 278
 279 static unsigned int fls_index_from_chunk_index( unsigned int chunk_index, unsigned int index )
 280 {
 281     return 0x10 * ((1 << chunk_index) - 1) + index;
 282 }
 283
 284 static unsigned int fls_chunk_index_from_index( unsigned int index, unsigned int *index_in_chunk )
 285 {
 286     unsigned int chunk_index = 0;
 287
 288     while (index >= fls_chunk_size( chunk_index ))
 289         index -= fls_chunk_size( chunk_index++ );
 290
 291     *index_in_chunk = index;
 292     return chunk_index;
 293 }
 294
 295 TEB_FLS_DATA *fls_alloc_data(void)
 296 {
 297     TEB_FLS_DATA *fls;
 298
 299     if (!(fls = RtlAllocateHeap( GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(*fls) )))
 300         return NULL;
 301
 302     lock_fls_data();
 303     InsertTailList( &fls_data.fls_list_head, &fls->fls_list_entry );
 304     unlock_fls_data();
 305
 306     return fls;
 307 }
 308
 309
 310 /***********************************************************************
 311  *              RtlFlsAlloc  (NTDLL.@)
 312  */
 313 NTSTATUS WINAPI DECLSPEC_HOTPATCH RtlFlsAlloc( PFLS_CALLBACK_FUNCTION callback, ULONG *ret_index )
 314 {
 315     unsigned int chunk_index, index, i;
 316     FLS_INFO_CHUNK *chunk;
 317     TEB_FLS_DATA *fls;
 318
 319     if (!(fls = NtCurrentTeb()->FlsSlots)
 320             && !(NtCurrentTeb()->FlsSlots = fls = fls_alloc_data()))
 321         return STATUS_NO_MEMORY;
 322
 323     lock_fls_data();
 324     for (i = 0; i < ARRAY_SIZE(fls_data.fls_callback_chunks); ++i)
 325     {
 326         if (!fls_data.fls_callback_chunks[i] || fls_data.fls_callback_chunks[i]->count < fls_chunk_size( i ))
 327             break;
 328     }
 329
 330     if ((chunk_index = i) == ARRAY_SIZE(fls_data.fls_callback_chunks))
 331     {
 332         unlock_fls_data();
 333         return STATUS_NO_MEMORY;
 334     }
 335
 336     if ((chunk = fls_data.fls_callback_chunks[chunk_index]))
 337     {
 338         for (index = 0; index < fls_chunk_size( chunk_index ); ++index)
 339             if (!chunk->callbacks[index].callback)
 340                 break;
 341         assert( index < fls_chunk_size( chunk_index ));
 342     }
 343     else
 344     {
 345         fls_data.fls_callback_chunks[chunk_index] = chunk = RtlAllocateHeap( GetProcessHeap(), HEAP_ZERO_MEMORY,
 346                 offsetof(FLS_INFO_CHUNK, callbacks) + sizeof(*chunk->callbacks) * fls_chunk_size( chunk_index ));
 347         if (!chunk)
 348         {
 349             unlock_fls_data();
 350             return STATUS_NO_MEMORY;
 351         }
 352
 353         if (chunk_index)
 354         {
 355             index = 0;
 356         }
 357         else
 358         {
 359             chunk->count = 1; /* FLS index 0 is prohibited. */
 360             chunk->callbacks[0].callback = (void *)~(ULONG_PTR)0;
 361             index = 1;
 362         }
 363     }
 364
 365     ++chunk->count;
 366     chunk->callbacks[index].callback = callback ? callback : (PFLS_CALLBACK_FUNCTION)~(ULONG_PTR)0;
 367
 368     if ((*ret_index = fls_index_from_chunk_index( chunk_index, index )) > fls_data.fls_high_index)
 369         fls_data.fls_high_index = *ret_index;
 370
 371     unlock_fls_data();
 372
 373     return STATUS_SUCCESS;
 374 }
 375
 376
 377 /***********************************************************************
 378  *              RtlFlsFree   (NTDLL.@)
 379  */
 380 NTSTATUS WINAPI DECLSPEC_HOTPATCH RtlFlsFree( ULONG index )
 381 {
 382     PFLS_CALLBACK_FUNCTION callback;
 383     unsigned int chunk_index, idx;
 384     FLS_INFO_CHUNK *chunk;
 385     LIST_ENTRY *entry;
 386
 387     lock_fls_data();
 388
 389     if (!index || index > fls_data.fls_high_index)
 390     {
 391         unlock_fls_data();
 392         return STATUS_INVALID_PARAMETER;
 393     }
 394
 395     chunk_index = fls_chunk_index_from_index( index, &idx );
 396     if (!(chunk = fls_data.fls_callback_chunks[chunk_index])
 397             || !(callback = chunk->callbacks[idx].callback))
 398     {
 399         unlock_fls_data();
 400         return STATUS_INVALID_PARAMETER;
 401     }
 402
 403     for (entry = fls_data.fls_list_head.Flink; entry != &fls_data.fls_list_head; entry = entry->Flink)
 404     {
 405         TEB_FLS_DATA *fls = CONTAINING_RECORD(entry, TEB_FLS_DATA, fls_list_entry);
 406
 407         if (fls->fls_data_chunks[chunk_index] && fls->fls_data_chunks[chunk_index][idx + 1])
 408         {
 409             if (callback != (void *)~(ULONG_PTR)0)
 410             {
 411                 TRACE_(relay)("Calling FLS callback %p, arg %p.\n", callback,
 412                         fls->fls_data_chunks[chunk_index][idx + 1]);
 413
 414                 callback( fls->fls_data_chunks[chunk_index][idx + 1] );
 415             }
 416             fls->fls_data_chunks[chunk_index][idx + 1] = NULL;
 417         }
 418     }
 419
 420     --chunk->count;
 421     chunk->callbacks[idx].callback = NULL;
 422
 423     unlock_fls_data();
 424     return STATUS_SUCCESS;
 425 }
 426
 427
 428 /***********************************************************************
 429  *              RtlFlsSetValue (NTDLL.@)
 430  */
 431 NTSTATUS WINAPI DECLSPEC_HOTPATCH RtlFlsSetValue( ULONG index, void *data )
 432 {
 433     unsigned int chunk_index, idx;
 434     TEB_FLS_DATA *fls;
 435
 436     if (!index || index >= MAX_FLS_DATA_COUNT)
 437         return STATUS_INVALID_PARAMETER;
 438
 439     if (!(fls = NtCurrentTeb()->FlsSlots)
 440             && !(NtCurrentTeb()->FlsSlots = fls = fls_alloc_data()))
 441         return STATUS_NO_MEMORY;
 442
 443     chunk_index = fls_chunk_index_from_index( index, &idx );
 444
 445     if (!fls->fls_data_chunks[chunk_index] &&
 446             !(fls->fls_data_chunks[chunk_index] = RtlAllocateHeap( GetProcessHeap(), HEAP_ZERO_MEMORY,
 447             (fls_chunk_size( chunk_index ) + 1) * sizeof(*fls->fls_data_chunks[chunk_index]) )))
 448         return STATUS_NO_MEMORY;
 449
 450     fls->fls_data_chunks[chunk_index][idx + 1] = data;
 451
 452     return STATUS_SUCCESS;
 453 }
 454
 455
 456 /***********************************************************************
 457  *              RtlFlsGetValue (NTDLL.@)
 458  */
 459 NTSTATUS WINAPI DECLSPEC_HOTPATCH RtlFlsGetValue( ULONG index, void **data )
 460 {
 461     unsigned int chunk_index, idx;
 462     TEB_FLS_DATA *fls;
 463
 464     if (!index || index >= MAX_FLS_DATA_COUNT || !(fls = NtCurrentTeb()->FlsSlots))
 465         return STATUS_INVALID_PARAMETER;
 466
 467     chunk_index = fls_chunk_index_from_index( index, &idx );
 468
 469     *data = fls->fls_data_chunks[chunk_index] ? fls->fls_data_chunks[chunk_index][idx + 1] : NULL;
 470     return STATUS_SUCCESS;
 471 }
 472
 473
 474 /***********************************************************************
 475  *              RtlProcessFlsData (NTDLL.@)
 476  */
 477 void WINAPI DECLSPEC_HOTPATCH RtlProcessFlsData( void *teb_fls_data, ULONG flags )
 478 {
 479     TEB_FLS_DATA *fls = teb_fls_data;
 480     unsigned int i, index;
 481
 482     TRACE_(thread)( "teb_fls_data %p, flags %#x.\n", teb_fls_data, flags );
 483
 484     if (flags & ~3)
 485         FIXME_(thread)( "Unknown flags %#x.\n", flags );
 486
 487     if (!fls)
 488         return;
 489
 490     if (flags & 1)
 491     {
 492         lock_fls_data();
 493         for (i = 0; i < ARRAY_SIZE(fls->fls_data_chunks); ++i)
 494         {
 495             if (!fls->fls_data_chunks[i] || !fls_data.fls_callback_chunks[i]
 496                     || !fls_data.fls_callback_chunks[i]->count)
 497                 continue;
 498
 499             for (index = 0; index < fls_chunk_size( i ); ++index)
 500             {
 501                 PFLS_CALLBACK_FUNCTION callback = fls_data.fls_callback_chunks[i]->callbacks[index].callback;
 502
 503                 if (!fls->fls_data_chunks[i][index + 1])
 504                     continue;
 505
 506                 if (callback && callback != (void *)~(ULONG_PTR)0)
 507                 {
 508                     TRACE_(relay)("Calling FLS callback %p, arg %p.\n", callback,
 509                             fls->fls_data_chunks[i][index + 1]);
 510
 511                     callback( fls->fls_data_chunks[i][index + 1] );
 512                 }
 513                 fls->fls_data_chunks[i][index + 1] = NULL;
 514             }
 515         }
 516         /* Not using RemoveEntryList() as Windows does not zero list entry here. */
 517         fls->fls_list_entry.Flink->Blink = fls->fls_list_entry.Blink;
 518         fls->fls_list_entry.Blink->Flink = fls->fls_list_entry.Flink;
 519         unlock_fls_data();
 520     }
 521
 522     if (flags & 2)
 523     {
 524         for (i = 0; i < ARRAY_SIZE(fls->fls_data_chunks); ++i)
 525             RtlFreeHeap( GetProcessHeap(), 0, fls->fls_data_chunks[i] );
 526
 527         RtlFreeHeap( GetProcessHeap(), 0, fls );
 528     }
 529 }