scheduler/thread.c

   1 /*
   2  * Win32 threads
   3  *
   4  * Copyright 1996 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20
  21 #include "config.h"
  22 #include "wine/port.h"
  23
  24 #include <assert.h>
  25 #include <fcntl.h>
  26 #include <sys/types.h>
  27 #ifdef HAVE_SYS_MMAN_H
  28 #include <sys/mman.h>
  29 #endif
  30 #ifdef HAVE_SYS_TIMES_H
  31 #include <sys/times.h>
  32 #endif
  33 #ifdef HAVE_UNISTD_H
  34 # include <unistd.h>
  35 #endif
  36 #include "wine/winbase16.h"
  37 #include "thread.h"
  38 #include "task.h"
  39 #include "module.h"
  40 #include "winerror.h"
  41 #include "selectors.h"
  42 #include "winnt.h"
  43 #include "wine/server.h"
  44 #include "stackframe.h"
  45 #include "wine/debug.h"
  46 #include "winnls.h"
  47
  48 WINE_DEFAULT_DEBUG_CHANNEL(thread);
  49 WINE_DECLARE_DEBUG_CHANNEL(relay);
  50
  51 /* TEB of the initial thread */
  52 static TEB initial_teb;
  53
  54 extern struct _PDB current_process;
  55
  56 /***********************************************************************
  57  *           THREAD_IdToTEB
  58  *
  59  * Convert a thread id to a TEB, making sure it is valid.
  60  */
  61 TEB *THREAD_IdToTEB( DWORD id )
  62 {
  63     TEB *ret = NULL;
  64
  65     if (!id || id == GetCurrentThreadId()) return NtCurrentTeb();
  66
  67     SERVER_START_REQ( get_thread_info )
  68     {
  69         req->handle = 0;
  70         req->tid_in = id;
  71         if (!wine_server_call( req )) ret = reply->teb;
  72     }
  73     SERVER_END_REQ;
  74
  75     if (!ret)
  76     {
  77         /* Allow task handles to be used; convert to main thread */
  78         if ( IsTask16( id ) )
  79         {
  80             TDB *pTask = TASK_GetPtr( id );
  81             if (pTask) return pTask->teb;
  82         }
  83         SetLastError( ERROR_INVALID_PARAMETER );
  84     }
  85     return ret;
  86 }
  87
  88
  89 /***********************************************************************
  90  *           THREAD_InitTEB
  91  *
  92  * Initialization of a newly created TEB.
  93  */
  94 static BOOL THREAD_InitTEB( TEB *teb )
  95 {
  96     teb->except    = (void *)~0UL;
  97     teb->self      = teb;
  98     teb->tibflags  = TEBF_WIN32;
  99     teb->exit_code = STILL_ACTIVE;
 100     teb->request_fd = -1;
 101     teb->reply_fd   = -1;
 102     teb->wait_fd[0] = -1;
 103     teb->wait_fd[1] = -1;
 104     teb->stack_top  = (void *)~0UL;
 105     teb->StaticUnicodeString.MaximumLength = sizeof(teb->StaticUnicodeBuffer);
 106     teb->StaticUnicodeString.Buffer = (PWSTR)teb->StaticUnicodeBuffer;
 107     teb->teb_sel = wine_ldt_alloc_fs();
 108     return (teb->teb_sel != 0);
 109 }
 110
 111
 112 /***********************************************************************
 113  *           THREAD_FreeTEB
 114  *
 115  * Free data structures associated with a thread.
 116  * Must be called from the context of another thread.
 117  */
 118 static void THREAD_FreeTEB( TEB *teb )
 119 {
 120     TRACE("(%p) called\n", teb );
 121     /* Free the associated memory */
 122     wine_ldt_free_fs( teb->teb_sel );
 123     VirtualFree( teb->stack_base, 0, MEM_RELEASE );
 124 }
 125
 126
 127 /***********************************************************************
 128  *           THREAD_InitStack
 129  *
 130  * Allocate the stack of a thread.
 131  */
 132 TEB *THREAD_InitStack( TEB *teb, DWORD stack_size )
 133 {
 134     DWORD old_prot, total_size;
 135     DWORD page_size = getpagesize();
 136     void *base;
 137
 138     /* Allocate the stack */
 139
 140     if (stack_size >= 16*1024*1024)
 141         WARN("Thread stack size is %ld MB.\n",stack_size/1024/1024);
 142
 143     /* if size is smaller than default, get stack size from parent */
 144     if (stack_size < 1024 * 1024)
 145     {
 146         if (teb)
 147             stack_size = 1024 * 1024;  /* no parent */
 148         else
 149             stack_size = ((char *)NtCurrentTeb()->stack_top - (char *)NtCurrentTeb()->stack_base
 150                           - SIGNAL_STACK_SIZE - 3 * page_size);
 151     }
 152
 153     /* FIXME: some Wine functions use a lot of stack, so we add 64Kb here */
 154     stack_size += 64 * 1024;
 155
 156     /* Memory layout in allocated block:
 157      *
 158      *   size                 contents
 159      * 1 page              NOACCESS guard page
 160      * SIGNAL_STACK_SIZE   signal stack
 161      * 1 page              NOACCESS guard page
 162      * 1 page              PAGE_GUARD guard page
 163      * stack_size          normal stack
 164      * 1 page              TEB (except for initial thread)
 165      * 1 page              debug info (except for initial thread)
 166      */
 167
 168     stack_size = (stack_size + (page_size - 1)) & ~(page_size - 1);
 169     total_size = stack_size + SIGNAL_STACK_SIZE + 3 * page_size;
 170     if (!teb) total_size += 2 * page_size;
 171
 172     if (!(base = VirtualAlloc( NULL, total_size, MEM_COMMIT, PAGE_EXECUTE_READWRITE )))
 173         return NULL;
 174
 175     if (!teb)
 176     {
 177         teb = (TEB *)((char *)base + total_size - 2 * page_size);
 178         if (!THREAD_InitTEB( teb ))
 179         {
 180             VirtualFree( base, 0, MEM_RELEASE );
 181             return NULL;
 182         }
 183         teb->debug_info = (char *)teb + page_size;
 184     }
 185
 186     teb->stack_low    = base;
 187     teb->stack_base   = base;
 188     teb->signal_stack = (char *)base + page_size;
 189     teb->stack_top    = (char *)base + 3 * page_size + SIGNAL_STACK_SIZE + stack_size;
 190
 191     /* Setup guard pages */
 192
 193     VirtualProtect( base, 1, PAGE_NOACCESS, &old_prot );
 194     VirtualProtect( (char *)teb->signal_stack + SIGNAL_STACK_SIZE, 1, PAGE_NOACCESS, &old_prot );
 195     VirtualProtect( (char *)teb->signal_stack + SIGNAL_STACK_SIZE + page_size, 1,
 196                     PAGE_EXECUTE_READWRITE | PAGE_GUARD, &old_prot );
 197     return teb;
 198 }
 199
 200
 201 /***********************************************************************
 202  *           THREAD_Init
 203  *
 204  * Setup the initial thread.
 205  *
 206  * NOTES: The first allocated TEB on NT is at 0x7ffde000.
 207  */
 208 void THREAD_Init(void)
 209 {
 210     if (!initial_teb.self)  /* do it only once */
 211     {
 212         THREAD_InitTEB( &initial_teb );
 213         assert( initial_teb.teb_sel );
 214         initial_teb.Peb = (PEB *)&current_process;  /* FIXME */
 215         SYSDEPS_SetCurThread( &initial_teb );
 216         SYSDEPS_InitErrno();
 217     }
 218 }
 219
 220 DECL_GLOBAL_CONSTRUCTOR(thread_init) { THREAD_Init(); }
 221
 222
 223 /***********************************************************************
 224  *           THREAD_Start
 225  *
 226  * Start execution of a newly created thread. Does not return.
 227  */
 228 static void THREAD_Start(void)
 229 {
 230     LPTHREAD_START_ROUTINE func = (LPTHREAD_START_ROUTINE)NtCurrentTeb()->entry_point;
 231
 232     if (TRACE_ON(relay))
 233         DPRINTF("%04lx:Starting thread (entryproc=%p)\n", GetCurrentThreadId(), func );
 234
 235     __TRY
 236     {
 237         MODULE_DllThreadAttach( NULL );
 238         ExitThread( func( NtCurrentTeb()->entry_arg ) );
 239     }
 240     __EXCEPT(UnhandledExceptionFilter)
 241     {
 242         TerminateThread( GetCurrentThread(), GetExceptionCode() );
 243     }
 244     __ENDTRY
 245 }
 246
 247
 248 /***********************************************************************
 249  *           CreateThread   (KERNEL32.@)
 250  */
 251 HANDLE WINAPI CreateThread( SECURITY_ATTRIBUTES *sa, SIZE_T stack,
 252                             LPTHREAD_START_ROUTINE start, LPVOID param,
 253                             DWORD flags, LPDWORD id )
 254 {
 255     HANDLE handle = 0;
 256     TEB *teb;
 257     DWORD tid = 0;
 258     int request_pipe[2];
 259
 260     if (pipe( request_pipe ) == -1)
 261     {
 262         SetLastError( ERROR_TOO_MANY_OPEN_FILES );
 263         return 0;
 264     }
 265     fcntl( request_pipe[1], F_SETFD, 1 ); /* set close on exec flag */
 266     wine_server_send_fd( request_pipe[0] );
 267
 268     SERVER_START_REQ( new_thread )
 269     {
 270         req->suspend    = ((flags & CREATE_SUSPENDED) != 0);
 271         req->inherit    = (sa && (sa->nLength>=sizeof(*sa)) && sa->bInheritHandle);
 272         req->request_fd = request_pipe[0];
 273         if (!wine_server_call_err( req ))
 274         {
 275             handle = reply->handle;
 276             tid = reply->tid;
 277         }
 278         close( request_pipe[0] );
 279     }
 280     SERVER_END_REQ;
 281
 282     if (!handle || !(teb = THREAD_InitStack( NULL, stack )))
 283     {
 284         close( request_pipe[1] );
 285         return 0;
 286     }
 287
 288     teb->Peb         = NtCurrentTeb()->Peb;
 289     teb->tid         = tid;
 290     teb->request_fd  = request_pipe[1];
 291     teb->entry_point = start;
 292     teb->entry_arg   = param;
 293     teb->startup     = THREAD_Start;
 294     teb->htask16     = GetCurrentTask();
 295
 296     if (id) *id = tid;
 297     if (SYSDEPS_SpawnThread( teb ) == -1)
 298     {
 299         CloseHandle( handle );
 300         close( request_pipe[1] );
 301         THREAD_FreeTEB( teb );
 302         return 0;
 303     }
 304     return handle;
 305 }
 306
 307 /***********************************************************************
 308  * ExitThread [KERNEL32.@]  Ends a thread
 309  *
 310  * RETURNS
 311  *    None
 312  */
 313 void WINAPI ExitThread( DWORD code ) /* [in] Exit code for this thread */
 314 {
 315     BOOL last;
 316     SERVER_START_REQ( terminate_thread )
 317     {
 318         /* send the exit code to the server */
 319         req->handle    = GetCurrentThread();
 320         req->exit_code = code;
 321         wine_server_call( req );
 322         last = reply->last;
 323     }
 324     SERVER_END_REQ;
 325
 326     if (last)
 327     {
 328         LdrShutdownProcess();
 329         exit( code );
 330     }
 331     else
 332     {
 333         LdrShutdownThread();
 334         if (!(NtCurrentTeb()->tibflags & TEBF_WIN32)) TASK_ExitTask();
 335         SYSDEPS_ExitThread( code );
 336     }
 337 }
 338
 339 /***********************************************************************
 340  * OpenThread Retrieves a handle to a thread from its thread id
 341  *
 342  * RETURNS
 343  *    None
 344  */
 345 HANDLE WINAPI OpenThread( DWORD dwDesiredAccess, BOOL bInheritHandle, DWORD dwThreadId )
 346 {
 347     HANDLE ret = 0;
 348     SERVER_START_REQ( open_thread )
 349     {
 350         req->tid     = dwThreadId;
 351         req->access  = dwDesiredAccess;
 352         req->inherit = bInheritHandle;
 353         if (!wine_server_call_err( req )) ret = reply->handle;
 354     }
 355     SERVER_END_REQ;
 356     return ret;
 357 }
 358
 359 /**********************************************************************
 360  * TerminateThread [KERNEL32.@]  Terminates a thread
 361  *
 362  * RETURNS
 363  *    Success: TRUE
 364  *    Failure: FALSE
 365  */
 366 BOOL WINAPI TerminateThread( HANDLE handle,    /* [in] Handle to thread */
 367                              DWORD exit_code)  /* [in] Exit code for thread */
 368 {
 369     NTSTATUS status = NtTerminateThread( handle, exit_code );
 370     if (status) SetLastError( RtlNtStatusToDosError(status) );
 371     return !status;
 372 }
 373
 374
 375 /**********************************************************************
 376  *              GetExitCodeThread (KERNEL32.@)
 377  *
 378  * Gets termination status of thread.
 379  *
 380  * RETURNS
 381  *    Success: TRUE
 382  *    Failure: FALSE
 383  */
 384 BOOL WINAPI GetExitCodeThread(
 385     HANDLE hthread, /* [in]  Handle to thread */
 386     LPDWORD exitcode) /* [out] Address to receive termination status */
 387 {
 388     THREAD_BASIC_INFORMATION info;
 389     NTSTATUS status = NtQueryInformationThread( hthread, ThreadBasicInformation,
 390                                                 &info, sizeof(info), NULL );
 391
 392     if (status)
 393     {
 394         SetLastError( RtlNtStatusToDosError(status) );
 395         return FALSE;
 396     }
 397     if (exitcode) *exitcode = info.ExitStatus;
 398     return TRUE;
 399 }
 400
 401
 402 /* callback for QueueUserAPC */
 403 static void CALLBACK call_user_apc( ULONG_PTR arg1, ULONG_PTR arg2, ULONG_PTR arg3 )
 404 {
 405     PAPCFUNC func = (PAPCFUNC)arg1;
 406     func( arg2 );
 407 }
 408
 409 /***********************************************************************
 410  *              QueueUserAPC  (KERNEL32.@)
 411  */
 412 DWORD WINAPI QueueUserAPC( PAPCFUNC func, HANDLE hthread, ULONG_PTR data )
 413 {
 414     NTSTATUS status = NtQueueApcThread( hthread, call_user_apc, (ULONG_PTR)func, data, 0 );
 415
 416     if (status) SetLastError( RtlNtStatusToDosError(status) );
 417     return !status;
 418 }
 419
 420
 421 /***********************************************************************
 422  * ProcessIdToSessionId   (KERNEL32.@)
 423  * This function is available on Terminal Server 4SP4 and Windows 2000
 424  */
 425 BOOL WINAPI ProcessIdToSessionId( DWORD procid, DWORD *sessionid_ptr )
 426 {
 427         /* According to MSDN, if the calling process is not in a terminal
 428          * services environment, then the sessionid returned is zero.
 429          */
 430         *sessionid_ptr = 0;
 431         return TRUE;
 432 }
 433
 434
 435 #ifdef __i386__
 436
 437 /***********************************************************************
 438  *              SetLastError (KERNEL.147)
 439  *              SetLastError (KERNEL32.@)
 440  */
 441 /* void WINAPI SetLastError( DWORD error ); */
 442 __ASM_GLOBAL_FUNC( SetLastError,
 443                    "movl 4(%esp),%eax\n\t"
 444                    ".byte 0x64\n\t"
 445                    "movl %eax,0x60\n\t"
 446                    "ret $4" );
 447
 448 /***********************************************************************
 449  *              GetLastError (KERNEL.148)
 450  *              GetLastError (KERNEL32.@)
 451  */
 452 /* DWORD WINAPI GetLastError(void); */
 453 __ASM_GLOBAL_FUNC( GetLastError, ".byte 0x64\n\tmovl 0x60,%eax\n\tret" );
 454
 455 /***********************************************************************
 456  *              GetCurrentProcessId (KERNEL.471)
 457  *              GetCurrentProcessId (KERNEL32.@)
 458  */
 459 /* DWORD WINAPI GetCurrentProcessId(void) */
 460 __ASM_GLOBAL_FUNC( GetCurrentProcessId, ".byte 0x64\n\tmovl 0x20,%eax\n\tret" );
 461
 462 /***********************************************************************
 463  *              GetCurrentThreadId (KERNEL.462)
 464  *              GetCurrentThreadId (KERNEL32.@)
 465  */
 466 /* DWORD WINAPI GetCurrentThreadId(void) */
 467 __ASM_GLOBAL_FUNC( GetCurrentThreadId, ".byte 0x64\n\tmovl 0x24,%eax\n\tret" );
 468
 469 #else  /* __i386__ */
 470
 471 /**********************************************************************
 472  *              SetLastError (KERNEL.147)
 473  *              SetLastError (KERNEL32.@)
 474  *
 475  * Sets the last-error code.
 476  */
 477 void WINAPI SetLastError( DWORD error ) /* [in] Per-thread error code */
 478 {
 479     NtCurrentTeb()->last_error = error;
 480 }
 481
 482 /**********************************************************************
 483  *              GetLastError (KERNEL.148)
 484  *              GetLastError (KERNEL32.@)
 485  *
 486  * Returns last-error code.
 487  */
 488 DWORD WINAPI GetLastError(void)
 489 {
 490     return NtCurrentTeb()->last_error;
 491 }
 492
 493 /***********************************************************************
 494  *              GetCurrentProcessId (KERNEL.471)
 495  *              GetCurrentProcessId (KERNEL32.@)
 496  *
 497  * Returns process identifier.
 498  */
 499 DWORD WINAPI GetCurrentProcessId(void)
 500 {
 501     return (DWORD)NtCurrentTeb()->pid;
 502 }
 503
 504 /***********************************************************************
 505  *              GetCurrentThreadId (KERNEL.462)
 506  *              GetCurrentThreadId (KERNEL32.@)
 507  *
 508  * Returns thread identifier.
 509  */
 510 DWORD WINAPI GetCurrentThreadId(void)
 511 {
 512     return NtCurrentTeb()->tid;
 513 }
 514
 515 #endif  /* __i386__ */