Added process_id_t and thread_it_t types to the server interface
[wine] / scheduler / 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 #include "thread.h"
45 #include "wine/server.h"
46 #include "winbase.h"
47 #include "wine/winbase16.h"
48 #include "wine/exception.h"
49 #include "wine/library.h"
50 #include "wine/debug.h"
51
52 WINE_DEFAULT_DEBUG_CHANNEL(thread);
53
54 #if defined(linux) || defined(HAVE_CLONE)
55 # ifdef HAVE_SCHED_H
56 #  include <sched.h>
57 # endif
58 # ifndef CLONE_VM
59 #  define CLONE_VM      0x00000100
60 #  define CLONE_FS      0x00000200
61 #  define CLONE_FILES   0x00000400
62 #  define CLONE_SIGHAND 0x00000800
63 #  define CLONE_PID     0x00001000
64 # endif  /* CLONE_VM */
65 #endif  /* linux || HAVE_CLONE */
66
67 extern void SELECTOR_FreeFs(void);
68
69 struct thread_cleanup_info
70 {
71     void *stack_base;
72     int   stack_size;
73     int   status;
74 };
75
76 /* temporary stacks used on thread exit */
77 #define TEMP_STACK_SIZE 1024
78 #define NB_TEMP_STACKS  8
79 static char temp_stacks[NB_TEMP_STACKS][TEMP_STACK_SIZE];
80 static LONG next_temp_stack;  /* next temp stack to use */
81
82 /***********************************************************************
83  *           SYSDEPS_SetCurThread
84  *
85  * Make 'thread' the current thread.
86  */
87 void SYSDEPS_SetCurThread( TEB *teb )
88 {
89 #if defined(__i386__)
90     /* On the i386, the current thread is in the %fs register */
91     wine_set_fs( teb->teb_sel );
92 #elif defined(__powerpc__)
93     /* On PowerPC, the current TEB is in the gpr13 register */
94     __asm__ __volatile__("mr 2, %0" : : "r" (teb));
95 #elif defined(HAVE__LWP_CREATE)
96     /* On non-i386 Solaris, we use the LWP private pointer */
97     _lwp_setprivate( teb );
98 #endif
99 }
100
101
102 /***********************************************************************
103  *           call_on_thread_stack
104  *
105  * Call a function once we switched to the thread stack.
106  */
107 static void call_on_thread_stack( void *func )
108 {
109     __TRY
110     {
111         void (*funcptr)(void) = func;
112         funcptr();
113     }
114     __EXCEPT(UnhandledExceptionFilter)
115     {
116         TerminateThread( GetCurrentThread(), GetExceptionCode() );
117     }
118     __ENDTRY
119     SYSDEPS_ExitThread(0);  /* should never get here */
120 }
121
122
123 /***********************************************************************
124  *           get_temp_stack
125  *
126  * Get a temporary stack address to run the thread exit code on.
127  */
128 inline static char *get_temp_stack(void)
129 {
130     unsigned int next = InterlockedExchangeAdd( &next_temp_stack, 1 );
131     return temp_stacks[next % NB_TEMP_STACKS];
132 }
133
134
135 /***********************************************************************
136  *           cleanup_thread
137  *
138  * Cleanup the remains of a thread. Runs on a temporary stack.
139  */
140 static void cleanup_thread( void *ptr )
141 {
142     /* copy the info structure since it is on the stack we will free */
143     struct thread_cleanup_info info = *(struct thread_cleanup_info *)ptr;
144     munmap( info.stack_base, info.stack_size );
145     SELECTOR_FreeFs();
146 #ifdef HAVE__LWP_CREATE
147     _lwp_exit();
148 #endif
149     _exit( info.status );
150 }
151
152
153 /***********************************************************************
154  *           SYSDEPS_StartThread
155  *
156  * Startup routine for a new thread.
157  */
158 static void SYSDEPS_StartThread( TEB *teb )
159 {
160     SYSDEPS_SetCurThread( teb );
161     CLIENT_InitThread();
162     SIGNAL_Init();
163     __TRY
164     {
165         teb->startup();
166     }
167     __EXCEPT(UnhandledExceptionFilter)
168     {
169         TerminateThread( GetCurrentThread(), GetExceptionCode() );
170     }
171     __ENDTRY
172     SYSDEPS_ExitThread(0);  /* should never get here */
173 }
174
175
176 /***********************************************************************
177  *           SYSDEPS_SpawnThread
178  *
179  * Start running a new thread.
180  * Return -1 on error, 0 if OK.
181  */
182 int SYSDEPS_SpawnThread( TEB *teb )
183 {
184 #ifdef ERRNO_LOCATION
185
186 #if defined(linux) || defined(HAVE_CLONE)
187     const int flags = CLONE_VM | CLONE_FS | CLONE_FILES | SIGCHLD;
188     if (clone( (int (*)(void *))SYSDEPS_StartThread, teb->stack_top, flags, teb ) < 0)
189         return -1;
190     if (!(flags & CLONE_FILES)) close( teb->request_fd );  /* close the child socket in the parent */
191     return 0;
192 #endif
193
194 #ifdef HAVE_RFORK
195     const int flags = RFPROC | RFMEM; /*|RFFDG*/
196     void **sp = (void **)teb->stack_top;
197     *--sp = teb;
198     *--sp = 0;
199     *--sp = SYSDEPS_StartThread;
200     __asm__ __volatile__(
201     "pushl %2;\n\t"             /* flags */
202     "pushl $0;\n\t"             /* 0 ? */
203     "movl %1,%%eax;\n\t"        /* SYS_rfork */
204     ".byte 0x9a; .long 0; .word 7;\n\t" /* lcall 7:0... FreeBSD syscall */
205     "cmpl $0, %%edx;\n\t"
206     "je 1f;\n\t"
207     "movl %0,%%esp;\n\t"        /* child -> new thread */
208     "ret;\n"
209     "1:\n\t"            /* parent -> caller thread */
210     "addl $8,%%esp" :
211     : "r" (sp), "g" (SYS_rfork), "g" (flags)
212     : "eax", "edx");
213     if (flags & RFFDG) close( teb->request_fd );  /* close the child socket in the parent */
214     return 0;
215 #endif
216
217 #ifdef HAVE__LWP_CREATE
218     ucontext_t context;
219     _lwp_makecontext( &context, (void(*)(void *))SYSDEPS_StartThread, teb,
220                       NULL, teb->stack_base, (char *)teb->stack_top - (char *)teb->stack_base );
221     if ( _lwp_create( &context, 0, NULL ) )
222         return -1;
223     return 0;
224 #endif
225
226 #endif /* ERRNO_LOCATION */
227
228     FIXME("CreateThread: stub\n" );
229     return 0;
230 }
231
232
233 /***********************************************************************
234  *           SYSDEPS_CallOnStack
235  */
236 void DECLSPEC_NORETURN SYSDEPS_CallOnStack( void (*func)(LPVOID), LPVOID arg );
237 #ifdef __i386__
238 #ifdef __GNUC__
239 __ASM_GLOBAL_FUNC( SYSDEPS_CallOnStack,
240                    "movl 4(%esp),%ecx\n\t"  /* func */
241                    "movl 8(%esp),%edx\n\t"  /* arg */
242                    ".byte 0x64\n\tmovl 0x04,%esp\n\t"  /* teb->stack_top */
243                    "pushl %edx\n\t"
244                    "xorl %ebp,%ebp\n\t"
245                    "call *%ecx\n\t"
246                    "int $3" /* we never return here */ );
247 #elif defined(_MSC_VER)
248 __declspec(naked) void SYSDEPS_CallOnStack( void (*func)(LPVOID), LPVOID arg )
249 {
250   __asm mov ecx, 4[esp];
251   __asm mov edx, 8[esp];
252   __asm mov fs:[0x04], esp;
253   __asm push edx;
254   __asm xor ebp, ebp;
255   __asm call [ecx];
256   __asm int 3;
257 }
258 #endif /* defined(__GNUC__) || defined(_MSC_VER) */
259 #else /* !defined(__i386__) */
260 void SYSDEPS_CallOnStack( void (*func)(LPVOID), LPVOID arg )
261 {
262     func( arg );
263     while(1); /* avoid warning */
264 }
265 #endif /* !defined(__i386__) */
266
267
268 /***********************************************************************
269  *           SYSDEPS_SwitchToThreadStack
270  */
271 void SYSDEPS_SwitchToThreadStack( void (*func)(void) )
272 {
273     SYSDEPS_CallOnStack( call_on_thread_stack, func );
274 }
275
276
277 /***********************************************************************
278  *           SYSDEPS_ExitThread
279  *
280  * Exit a running thread; must not return.
281  */
282 void SYSDEPS_ExitThread( int status )
283 {
284     TEB *teb = NtCurrentTeb();
285     struct thread_cleanup_info info;
286     MEMORY_BASIC_INFORMATION meminfo;
287
288     FreeSelector16( teb->stack_sel );
289     VirtualQuery( teb->stack_top, &meminfo, sizeof(meminfo) );
290     info.stack_base = meminfo.AllocationBase;
291     info.stack_size = meminfo.RegionSize + ((char *)teb->stack_top - (char *)meminfo.AllocationBase);
292     info.status     = status;
293
294     SIGNAL_Reset();
295
296     VirtualFree( teb->stack_base, 0, MEM_RELEASE | MEM_SYSTEM );
297     close( teb->wait_fd[0] );
298     close( teb->wait_fd[1] );
299     close( teb->reply_fd );
300     close( teb->request_fd );
301     teb->stack_low = get_temp_stack();
302     teb->stack_top = (char *) teb->stack_low + TEMP_STACK_SIZE;
303     SYSDEPS_CallOnStack( cleanup_thread, &info );
304 }
305
306
307 /***********************************************************************
308  *           SYSDEPS_AbortThread
309  *
310  * Same as SYSDEPS_ExitThread, but must not do anything that requires a server call.
311  */
312 void SYSDEPS_AbortThread( int status )
313 {
314     SIGNAL_Reset();
315     close( NtCurrentTeb()->wait_fd[0] );
316     close( NtCurrentTeb()->wait_fd[1] );
317     close( NtCurrentTeb()->reply_fd );
318     close( NtCurrentTeb()->request_fd );
319 #ifdef HAVE__LWP_CREATE
320     _lwp_exit();
321 #endif
322     for (;;)  /* avoid warning */
323         _exit( status );
324 }
325
326
327 /**********************************************************************
328  *           NtCurrentTeb   (NTDLL.@)
329  *
330  * This will crash and burn if called before threading is initialized
331  */
332 #if defined(__i386__) && defined(__GNUC__)
333 __ASM_GLOBAL_FUNC( NtCurrentTeb, ".byte 0x64\n\tmovl 0x18,%eax\n\tret" );
334 #elif defined(__i386__) && defined(_MSC_VER)
335 /* Nothing needs to be done. MS C "magically" exports the inline version from winnt.h */
336 #elif defined(HAVE__LWP_CREATE)
337 /***********************************************************************
338  *              NtCurrentTeb (NTDLL.@)
339  */
340 struct _TEB * WINAPI NtCurrentTeb(void)
341 {
342     extern void *_lwp_getprivate(void);
343     return (struct _TEB *)_lwp_getprivate();
344 }
345 #elif defined(__powerpc__)
346 __ASM_GLOBAL_FUNC( NtCurrentTeb, "\n\tmr 3,2\n\tblr" );
347 #else
348 # error NtCurrentTeb not defined for this architecture
349 #endif  /* __i386__ */