Renamed a few more TEB fields.
[wine] / dlls / ntdll / sysdeps.c
1 /*
2  * System-dependent scheduler support
3  *
4  * Copyright 1998 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 <signal.h>
25 #include <stdio.h>
26 #ifdef HAVE_UNISTD_H
27 # include <unistd.h>
28 #endif
29 #ifdef HAVE_SYS_TIME_H
30 # include <sys/time.h>
31 #endif
32 #ifdef HAVE_SYS_SYSCALL_H
33 # include <sys/syscall.h>
34 #endif
35 #ifdef HAVE_SYS_LWP_H
36 # include <sys/lwp.h>
37 #endif
38 #ifdef HAVE_UCONTEXT_H
39 # include <ucontext.h>
40 #endif
41 #ifdef HAVE_SYS_MMAN_H
42 #include <sys/mman.h>
43 #endif
44 #ifdef HAVE_SCHED_H
45 #include <sched.h>
46 #endif
47
48 #ifdef HAVE_NPTL
49 #include <pthread.h>
50 #endif
51
52 #include "thread.h"
53 #include "wine/server.h"
54 #include "winbase.h"
55 #include "wine/library.h"
56 #include "wine/debug.h"
57
58 WINE_DEFAULT_DEBUG_CHANNEL(thread);
59
60 struct thread_cleanup_info
61 {
62     void *stack_base;
63     int   stack_size;
64     int   status;
65 };
66
67 /* temporary stacks used on thread exit */
68 #define TEMP_STACK_SIZE 1024
69 #define NB_TEMP_STACKS  8
70 static char temp_stacks[NB_TEMP_STACKS][TEMP_STACK_SIZE];
71 static LONG next_temp_stack;  /* next temp stack to use */
72
73 extern void PTHREAD_init_thread(void);
74
75 /***********************************************************************
76  *           SYSDEPS_SetCurThread
77  *
78  * Make 'thread' the current thread.
79  */
80 void SYSDEPS_SetCurThread( TEB *teb )
81 {
82 #if defined(__i386__)
83     /* On the i386, the current thread is in the %fs register */
84     LDT_ENTRY fs_entry;
85
86     wine_ldt_set_base( &fs_entry, teb );
87     wine_ldt_set_limit( &fs_entry, 0xfff );
88     wine_ldt_set_flags( &fs_entry, WINE_LDT_FLAGS_DATA|WINE_LDT_FLAGS_32BIT );
89     wine_ldt_init_fs( teb->teb_sel, &fs_entry );
90 #elif defined(__powerpc__)
91     /* On PowerPC, the current TEB is in the gpr13 register */
92 # ifdef __APPLE__
93     __asm__ __volatile__("mr r13, %0" : : "r" (teb));
94 # else
95     __asm__ __volatile__("mr 2, %0" : : "r" (teb));
96 # endif
97 #elif defined(HAVE__LWP_CREATE)
98     /* On non-i386 Solaris, we use the LWP private pointer */
99     _lwp_setprivate( teb );
100 #endif
101
102 #ifdef HAVE_NPTL
103     teb->pthread_data = (void *)pthread_self();
104 #else
105     PTHREAD_init_thread();
106 #endif
107 }
108
109
110 /***********************************************************************
111  *           get_temp_stack
112  *
113  * Get a temporary stack address to run the thread exit code on.
114  */
115 inline static char *get_temp_stack(void)
116 {
117     unsigned int next = interlocked_xchg_add( &next_temp_stack, 1 );
118     return temp_stacks[next % NB_TEMP_STACKS];
119 }
120
121
122 /***********************************************************************
123  *           cleanup_thread
124  *
125  * Cleanup the remains of a thread. Runs on a temporary stack.
126  */
127 static void cleanup_thread( void *ptr )
128 {
129     /* copy the info structure since it is on the stack we will free */
130     struct thread_cleanup_info info = *(struct thread_cleanup_info *)ptr;
131     munmap( info.stack_base, info.stack_size );
132     wine_ldt_free_fs( wine_get_fs() );
133 #ifdef HAVE__LWP_CREATE
134     _lwp_exit();
135 #endif
136     _exit( info.status );
137 }
138
139
140 /***********************************************************************
141  *           SYSDEPS_SpawnThread
142  *
143  * Start running a new thread.
144  * Return -1 on error, 0 if OK.
145  */
146 int SYSDEPS_SpawnThread( void (*func)(TEB *), TEB *teb )
147 {
148 #ifdef HAVE_NPTL
149     pthread_t id;
150     pthread_attr_t attr;
151
152     pthread_attr_init( &attr );
153     pthread_attr_setstack( &attr, teb->DeallocationStack,
154                            (char *)teb->Tib.StackBase - (char *)teb->DeallocationStack );
155     if (pthread_create( &id, &attr, (void * (*)(void *))func, teb )) return -1;
156     return 0;
157 #elif defined(HAVE_CLONE)
158     if (clone( (int (*)(void *))func, teb->Tib.StackBase,
159                CLONE_VM | CLONE_FS | CLONE_FILES | SIGCHLD, teb ) < 0)
160         return -1;
161     return 0;
162 #elif defined(HAVE_RFORK)
163     void **sp = (void **)teb->Tib.StackBase;
164     *--sp = teb;
165     *--sp = 0;
166     *--sp = func;
167     __asm__ __volatile__(
168     "pushl %2;\n\t"             /* flags */
169     "pushl $0;\n\t"             /* 0 ? */
170     "movl %1,%%eax;\n\t"        /* SYS_rfork */
171     ".byte 0x9a; .long 0; .word 7;\n\t" /* lcall 7:0... FreeBSD syscall */
172     "cmpl $0, %%edx;\n\t"
173     "je 1f;\n\t"
174     "movl %0,%%esp;\n\t"        /* child -> new thread */
175     "ret;\n"
176     "1:\n\t"            /* parent -> caller thread */
177     "addl $8,%%esp" :
178     : "r" (sp), "g" (SYS_rfork), "g" (RFPROC | RFMEM)
179     : "eax", "edx");
180     return 0;
181 #elif defined(HAVE__LWP_CREATE)
182     ucontext_t context;
183     _lwp_makecontext( &context, (void(*)(void *))func, teb,
184                       NULL, teb->DeallocationStack, (char *)teb->Tib.StackBase - (char *)teb->DeallocationStack );
185     if ( _lwp_create( &context, 0, NULL ) )
186         return -1;
187     return 0;
188 #endif
189
190     FIXME("CreateThread: stub\n" );
191     return -1;
192 }
193
194
195 /***********************************************************************
196  *           SYSDEPS_SwitchToThreadStack
197  *
198  * Switch to the stack specified in the current thread TEB
199  * and call the specified function.
200  */
201 void DECLSPEC_NORETURN SYSDEPS_SwitchToThreadStack( void (*func)(void *), void *arg );
202 #ifdef __i386__
203 #  ifdef __GNUC__
204 __ASM_GLOBAL_FUNC( SYSDEPS_SwitchToThreadStack,
205                    "movl 4(%esp),%ecx\n\t"  /* func */
206                    "movl 8(%esp),%edx\n\t"  /* arg */
207                    ".byte 0x64\n\tmovl 0x04,%esp\n\t"  /* teb->Tib.StackBase */
208                    "pushl %edx\n\t"
209                    "xorl %ebp,%ebp\n\t"
210                    "call *%ecx\n\t"
211                    "int $3" /* we never return here */ );
212 #  elif defined(_MSC_VER)
213 __declspec(naked) void SYSDEPS_SwitchToThreadStack( void (*func)(void *), void *arg )
214 {
215   __asm mov ecx, 4[esp];
216   __asm mov edx, 8[esp];
217   __asm mov fs:[0x04], esp;
218   __asm push edx;
219   __asm xor ebp, ebp;
220   __asm call [ecx];
221   __asm int 3;
222 }
223 #  endif /* defined(__GNUC__) || defined(_MSC_VER) */
224 #elif defined(__sparc__) && defined(__GNUC__)
225 __ASM_GLOBAL_FUNC( SYSDEPS_SwitchToThreadStack,
226                    "mov %o0, %l0\n\t" /* store first argument */
227                    "call " __ASM_NAME("NtCurrentTeb") ", 0\n\t"
228                    "mov %o1, %l1\n\t" /* delay slot: store second argument */
229                    "ld [%o0+4], %sp\n\t" /* teb->Tib.StackBase */
230                    "call %l0, 0\n\t" /* call func */
231                    "mov %l1, %o0\n\t" /* delay slot:  arg for func */
232                    "ta 0x01\n\t"); /* breakpoint - we never get here */
233 #elif defined(__powerpc__) && defined(__APPLE__)
234 /* Darwin SYSDEPS_SwitchToThreadStack
235  Function Pointer to call is on r3, Args to pass on r4 and stack on r1 */
236 __ASM_GLOBAL_FUNC( SYSDEPS_SwitchToThreadStack,
237                    "stw r1, 0x4(r13)\n\t" /* teb->Tib.StackBase */
238                    "mr r12,r3\n\t"
239                    "mtctr r12\n\t" /* func->ctr */
240                    "mr r3,r4\n\t" /* args->function param 1 (r3) */
241                    "bctr\n\t" /* call ctr */
242                    "b _SYSDEPS_SwitchToThreadStack+24\n\t"); /* loop */
243 #elif defined(__powerpc__) && defined(__GNUC__)
244 /* Linux SYSDEPS_SwitchToThreadStack
245  Function Pointer to call is on r3, Args to pass on r4 and stack on r1 */
246 __ASM_GLOBAL_FUNC( SYSDEPS_SwitchToThreadStack,
247                    "stw 1, 0x4(13)\n\t" /* teb->Tib.StackBase */
248                    "mr 12,3\n\t"
249                    "mtctr 12\n\t" /* func->ctr */
250                    "mr 3,4\n\t" /* args->function param 1 (r3) */
251                    "bctr\n\t" /* call ctr */
252                    "b _SYSDEPS_SwitchToThreadStack+24\n\t"); /* loop */
253 #else  /* !powerpc, !sparc, !i386 */
254 void SYSDEPS_SwitchToThreadStack( void (*func)(void *), void *arg )
255 {
256     func( arg );
257     while(1); /* avoid warning */
258 }
259 #endif /* !defined(__i386__) && !defined(__sparc__) */
260
261
262 /***********************************************************************
263  *           SYSDEPS_ExitThread
264  *
265  * Exit a running thread; must not return.
266  */
267 void SYSDEPS_ExitThread( int status )
268 {
269     TEB *teb = NtCurrentTeb();
270     DWORD size = 0;
271
272 #ifdef HAVE_NPTL
273     static TEB *teb_to_free;
274     TEB *free_teb;
275
276     if ((free_teb = interlocked_xchg_ptr( (void **)&teb_to_free, teb )) != NULL)
277     {
278         void *ptr;
279
280         TRACE("freeing prev teb %p stack %p fs %04x\n",
281               free_teb, free_teb->DeallocationStack, free_teb->teb_sel );
282
283         pthread_join( (pthread_t)free_teb->pthread_data, &ptr );
284         wine_ldt_free_fs( free_teb->teb_sel );
285         ptr = free_teb->DeallocationStack;
286         NtFreeVirtualMemory( GetCurrentProcess(), &ptr, &size, MEM_RELEASE );
287     }
288     SIGNAL_Block();
289     SYSDEPS_AbortThread( status );
290 #else
291     struct thread_cleanup_info info;
292     MEMORY_BASIC_INFORMATION meminfo;
293
294     NtQueryVirtualMemory( GetCurrentProcess(), teb->Tib.StackBase, MemoryBasicInformation,
295                           &meminfo, sizeof(meminfo), NULL );
296     info.stack_base = meminfo.AllocationBase;
297     info.stack_size = meminfo.RegionSize + ((char *)teb->Tib.StackBase - (char *)meminfo.AllocationBase);
298     info.status     = status;
299
300     SIGNAL_Block();
301     size = 0;
302     NtFreeVirtualMemory( GetCurrentProcess(), &teb->DeallocationStack, &size, MEM_RELEASE | MEM_SYSTEM );
303     close( teb->wait_fd[0] );
304     close( teb->wait_fd[1] );
305     close( teb->reply_fd );
306     close( teb->request_fd );
307     SIGNAL_Reset();
308     teb->Tib.StackLimit = get_temp_stack();
309     teb->Tib.StackBase = (char *)teb->Tib.StackLimit + TEMP_STACK_SIZE;
310     SYSDEPS_SwitchToThreadStack( cleanup_thread, &info );
311 #endif
312 }
313
314
315 /***********************************************************************
316  *           SYSDEPS_AbortThread
317  *
318  * Same as SYSDEPS_ExitThread, but must not do anything that requires a server call.
319  */
320 void SYSDEPS_AbortThread( int status )
321 {
322     SIGNAL_Block();
323     close( NtCurrentTeb()->wait_fd[0] );
324     close( NtCurrentTeb()->wait_fd[1] );
325     close( NtCurrentTeb()->reply_fd );
326     close( NtCurrentTeb()->request_fd );
327 #ifdef HAVE_NPTL
328     pthread_exit( (void *)status );
329 #endif
330     SIGNAL_Reset();
331 #ifdef HAVE__LWP_CREATE
332     _lwp_exit();
333 #endif
334     for (;;)  /* avoid warning */
335         _exit( status );
336 }
337
338 /***********************************************************************
339  *           SYSDEPS_GetUnixTid
340  *
341  * Get the Unix tid of the current thread.
342  */
343 int SYSDEPS_GetUnixTid(void)
344 {
345 #ifdef HAVE__LWP_SELF
346     return _lwp_self();
347 #elif defined(__linux__) && defined(__i386__)
348     int ret;
349     __asm__("int $0x80" : "=a" (ret) : "0" (224) /* SYS_gettid */);
350     if (ret < 0) ret = -1;
351     return ret;
352 #else
353     return -1;
354 #endif
355 }
356
357 /**********************************************************************
358  *           NtCurrentTeb   (NTDLL.@)
359  *
360  * This will crash and burn if called before threading is initialized
361  */
362 #if defined(__i386__) && defined(__GNUC__)
363 __ASM_GLOBAL_FUNC( NtCurrentTeb, ".byte 0x64\n\tmovl 0x18,%eax\n\tret" );
364 #elif defined(__i386__) && defined(_MSC_VER)
365 /* Nothing needs to be done. MS C "magically" exports the inline version from winnt.h */
366 #elif defined(HAVE__LWP_CREATE)
367 /***********************************************************************
368  *              NtCurrentTeb (NTDLL.@)
369  */
370 struct _TEB * WINAPI NtCurrentTeb(void)
371 {
372     extern void *_lwp_getprivate(void);
373     return (struct _TEB *)_lwp_getprivate();
374 }
375 #elif defined(__powerpc__)
376 # ifdef __APPLE__
377 __ASM_GLOBAL_FUNC( NtCurrentTeb, "\n\tmr r3,r13\n\tblr" );
378 # else
379 __ASM_GLOBAL_FUNC( NtCurrentTeb, "\n\tmr 3,2\n\tblr" );
380 # endif
381 #else
382 # error NtCurrentTeb not defined for this architecture
383 #endif  /* __i386__ */