Merged wine_call_to_16_long and wine_call_to_16_short into a single
[wine] / scheduler / pthread.c
1 /*
2  * pthread emulation for re-entrant libcs
3  *
4  * We can't use pthreads directly, so why not let libcs
5  * that want pthreads use Wine's own threading instead...
6  *
7  * Copyright 1999 Ove Kåven
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public
11  * License as published by the Free Software Foundation; either
12  * version 2.1 of the License, or (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with this library; if not, write to the Free Software
21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
22  */
23
24 #include "config.h"
25 #include "wine/port.h"
26
27 #define _GNU_SOURCE /* we may need to override some GNU extensions */
28
29 #include <assert.h>
30 #include <errno.h>
31 #include <stdlib.h>
32 #ifdef HAVE_UNISTD_H
33 # include <unistd.h>
34 #endif
35 #include <string.h>
36
37 #include "winbase.h"
38 #include "thread.h"
39 #include "winternl.h"
40
41 static int init_done;
42
43 void PTHREAD_init_done(void)
44 {
45     init_done = 1;
46 }
47
48 /* Currently this probably works only for glibc2,
49  * which checks for the presence of double-underscore-prepended
50  * pthread primitives, and use them if available.
51  * If they are not available, the libc defaults to
52  * non-threadsafe operation (not good). */
53
54 #if defined(__GLIBC__)
55 #include <pthread.h>
56 #include <signal.h>
57
58 #define PSTR(str) __ASM_NAME(#str)
59
60 /* adapt as necessary (a construct like this is used in glibc sources) */
61 #define strong_alias(orig, alias) \
62  asm(".globl " PSTR(alias) "\n" \
63      "\t.set " PSTR(alias) "," PSTR(orig))
64
65 /* strong_alias does not work on external symbols (.o format limitation?),
66  * so for those, we need to use the pogo stick */
67 #if defined(__i386__) && !defined(__PIC__)
68 /* FIXME: PIC */
69 #define jump_alias(orig, alias) __ASM_GLOBAL_FUNC( alias, "jmp " PSTR(orig))
70 #endif
71
72 /* get necessary libc symbols */
73 #if (__GLIBC__ == 2) && (__GLIBC_MINOR__ >= 1) && defined(HAVE___LIBC_FORK)
74 #define LIBC_FORK __libc_fork
75 #define PTHREAD_FORK __fork
76 #define ALIAS_FORK
77 #else
78 #define LIBC_FORK __fork
79 #define PTHREAD_FORK fork
80 #endif
81 extern pid_t LIBC_FORK(void);
82
83 #define LIBC_SIGACTION __sigaction
84 extern int LIBC_SIGACTION(int signum,
85                          const struct sigaction *act,
86                          struct sigaction *oldact);
87
88 /* NOTE: This is a truly extremely incredibly ugly hack!
89  * But it does seem to work... */
90
91 /* assume that pthread_mutex_t has room for at least one pointer,
92  * and hope that the users of pthread_mutex_t considers it opaque
93  * (never checks what's in it)
94  * also: assume that static initializer sets pointer to NULL
95  */
96 typedef struct {
97   CRITICAL_SECTION *critsect;
98 } *wine_mutex;
99
100 /* see wine_mutex above for comments */
101 typedef struct {
102   RTL_RWLOCK *lock;
103 } *wine_rwlock;
104
105 typedef struct _wine_cleanup {
106   void (*routine)(void *);
107   void *arg;
108 } *wine_cleanup;
109
110 typedef const void *key_data;
111
112 #define FIRST_KEY 0
113 #define MAX_KEYS 16 /* libc6 doesn't use that many, but... */
114
115 #define P_OUTPUT(stuff) write(2,stuff,strlen(stuff))
116
117 void __pthread_initialize(void)
118 {
119 }
120
121 struct pthread_thread_init {
122          void* (*start_routine)(void*);
123          void* arg;
124 };
125
126 static DWORD CALLBACK pthread_thread_start(LPVOID data)
127 {
128   struct pthread_thread_init init = *(struct pthread_thread_init*)data;
129   HeapFree(GetProcessHeap(),0,data);
130   return (DWORD)init.start_routine(init.arg);
131 }
132
133 int pthread_create(pthread_t* thread, const pthread_attr_t* attr, void*
134         (*start_routine)(void *), void* arg)
135 {
136   HANDLE hThread;
137   struct pthread_thread_init* idata = HeapAlloc(GetProcessHeap(), 0,
138                 sizeof(struct pthread_thread_init));
139
140   idata->start_routine = start_routine;
141   idata->arg = arg;
142   hThread = CreateThread(NULL, 0, pthread_thread_start, idata, 0, thread);
143
144   if(hThread)
145     CloseHandle(hThread);
146   else
147   {
148     HeapFree(GetProcessHeap(),0,idata); /* free idata struct on failure */
149     return EAGAIN;
150   }
151
152   return 0;
153 }
154
155 int pthread_cancel(pthread_t thread)
156 {
157   HANDLE hThread = OpenThread(THREAD_ALL_ACCESS, FALSE, thread);
158
159   if(!TerminateThread(hThread, 0))
160   {
161     CloseHandle(hThread);
162     return EINVAL;      /* return error */
163   }
164
165   CloseHandle(hThread);
166
167   return 0;             /* return success */
168 }
169
170 int pthread_join(pthread_t thread, void **value_ptr)
171 {
172   HANDLE hThread = OpenThread(THREAD_ALL_ACCESS, FALSE, thread);
173
174   WaitForSingleObject(hThread, INFINITE);
175   if(!GetExitCodeThread(hThread, (LPDWORD)value_ptr))
176   {
177     CloseHandle(hThread);
178     return EINVAL; /* FIXME: make this more correctly match */
179   }                /* windows errors */
180
181   CloseHandle(hThread);
182   return 0;
183 }
184
185 /*FIXME: not sure what to do with this one... */
186 int pthread_detach(pthread_t thread)
187 {
188   P_OUTPUT("FIXME:pthread_detach\n");
189   return 0;
190 }
191
192 /* FIXME: we have no equivalents in win32 for the policys */
193 /* so just keep this as a stub */
194 int pthread_attr_setschedpolicy(pthread_attr_t *attr, int policy)
195 {
196   P_OUTPUT("FIXME:pthread_attr_setschedpolicy\n");
197   return 0;
198 }
199
200 /* FIXME: no win32 equivalent for scope */
201 int pthread_attr_setscope(pthread_attr_t *attr, int scope)
202 {
203   P_OUTPUT("FIXME:pthread_attr_setscope\n");
204   return 0; /* return success */
205 }
206
207 /* FIXME: no win32 equivalent for schedule param */
208 int pthread_attr_setschedparam(pthread_attr_t *attr,
209     const struct sched_param *param)
210 {
211   P_OUTPUT("FIXME:pthread_attr_setschedparam\n");
212   return 0; /* return success */
213 }
214
215 int __pthread_once(pthread_once_t *once_control, void (*init_routine)(void))
216 {
217   static pthread_once_t the_once = PTHREAD_ONCE_INIT;
218   LONG once_now = *(LONG *)&the_once;
219
220   if (InterlockedCompareExchange((LONG*)once_control, once_now+1, once_now) == once_now)
221     (*init_routine)();
222   return 0;
223 }
224 strong_alias(__pthread_once, pthread_once);
225
226 void __pthread_kill_other_threads_np(void)
227 {
228     /* we don't need to do anything here */
229 }
230 strong_alias(__pthread_kill_other_threads_np, pthread_kill_other_threads_np);
231
232 /***** atfork *****/
233
234 #define MAX_ATFORK 8  /* libc doesn't need that many anyway */
235
236 static CRITICAL_SECTION atfork_section = CRITICAL_SECTION_INIT("atfork_section");
237 typedef void (*atfork_handler)();
238 static atfork_handler atfork_prepare[MAX_ATFORK];
239 static atfork_handler atfork_parent[MAX_ATFORK];
240 static atfork_handler atfork_child[MAX_ATFORK];
241 static int atfork_count;
242
243 int __pthread_atfork(void (*prepare)(void),
244                      void (*parent)(void),
245                      void (*child)(void))
246 {
247     if (init_done) EnterCriticalSection( &atfork_section );
248     assert( atfork_count < MAX_ATFORK );
249     atfork_prepare[atfork_count] = prepare;
250     atfork_parent[atfork_count] = parent;
251     atfork_child[atfork_count] = child;
252     atfork_count++;
253     if (init_done) LeaveCriticalSection( &atfork_section );
254     return 0;
255 }
256 strong_alias(__pthread_atfork, pthread_atfork);
257
258 pid_t PTHREAD_FORK(void)
259 {
260     pid_t pid;
261     int i;
262
263     EnterCriticalSection( &atfork_section );
264     /* prepare handlers are called in reverse insertion order */
265     for (i = atfork_count - 1; i >= 0; i--) if (atfork_prepare[i]) atfork_prepare[i]();
266     if (!(pid = LIBC_FORK()))
267     {
268         InitializeCriticalSection( &atfork_section );
269         for (i = 0; i < atfork_count; i++) if (atfork_child[i]) atfork_child[i]();
270     }
271     else
272     {
273         for (i = 0; i < atfork_count; i++) if (atfork_parent[i]) atfork_parent[i]();
274         LeaveCriticalSection( &atfork_section );
275     }
276     return pid;
277 }
278 #ifdef ALIAS_FORK
279 strong_alias(PTHREAD_FORK, fork);
280 #endif
281
282 /***** MUTEXES *****/
283
284 int __pthread_mutex_init(pthread_mutex_t *mutex,
285                         const pthread_mutexattr_t *mutexattr)
286 {
287   /* glibc has a tendency to initialize mutexes very often, even
288      in situations where they are not really used later on.
289
290      As for us, initializing a mutex is very expensive, we postpone
291      the real initialization until the time the mutex is first used. */
292
293   ((wine_mutex)mutex)->critsect = NULL;
294   return 0;
295 }
296 strong_alias(__pthread_mutex_init, pthread_mutex_init);
297
298 static void mutex_real_init( pthread_mutex_t *mutex )
299 {
300   CRITICAL_SECTION *critsect = HeapAlloc(GetProcessHeap(), 0, sizeof(CRITICAL_SECTION));
301   InitializeCriticalSection(critsect);
302
303   if (InterlockedCompareExchangePointer((void**)&(((wine_mutex)mutex)->critsect),critsect,NULL) != NULL) {
304     /* too late, some other thread already did it */
305     DeleteCriticalSection(critsect);
306     HeapFree(GetProcessHeap(), 0, critsect);
307   }
308 }
309
310 int __pthread_mutex_lock(pthread_mutex_t *mutex)
311 {
312   if (!init_done) return 0;
313   if (!((wine_mutex)mutex)->critsect)
314     mutex_real_init( mutex );
315
316   EnterCriticalSection(((wine_mutex)mutex)->critsect);
317   return 0;
318 }
319 strong_alias(__pthread_mutex_lock, pthread_mutex_lock);
320
321 int __pthread_mutex_trylock(pthread_mutex_t *mutex)
322 {
323   if (!init_done) return 0;
324   if (!((wine_mutex)mutex)->critsect)
325     mutex_real_init( mutex );
326
327   if (!TryEnterCriticalSection(((wine_mutex)mutex)->critsect)) {
328     errno = EBUSY;
329     return -1;
330   }
331   return 0;
332 }
333 strong_alias(__pthread_mutex_trylock, pthread_mutex_trylock);
334
335 int __pthread_mutex_unlock(pthread_mutex_t *mutex)
336 {
337   if (!((wine_mutex)mutex)->critsect) return 0;
338   LeaveCriticalSection(((wine_mutex)mutex)->critsect);
339   return 0;
340 }
341 strong_alias(__pthread_mutex_unlock, pthread_mutex_unlock);
342
343 int __pthread_mutex_destroy(pthread_mutex_t *mutex)
344 {
345   if (!((wine_mutex)mutex)->critsect) return 0;
346   if (((wine_mutex)mutex)->critsect->RecursionCount) {
347 #if 0 /* there seems to be a bug in libc6 that makes this a bad idea */
348     return EBUSY;
349 #else
350     while (((wine_mutex)mutex)->critsect->RecursionCount)
351       LeaveCriticalSection(((wine_mutex)mutex)->critsect);
352 #endif
353   }
354   DeleteCriticalSection(((wine_mutex)mutex)->critsect);
355   HeapFree(GetProcessHeap(), 0, ((wine_mutex)mutex)->critsect);
356   return 0;
357 }
358 strong_alias(__pthread_mutex_destroy, pthread_mutex_destroy);
359
360
361 /***** MUTEX ATTRIBUTES *****/
362 /* just dummies, since critical sections are always recursive */
363
364 int __pthread_mutexattr_init(pthread_mutexattr_t *attr)
365 {
366   return 0;
367 }
368 strong_alias(__pthread_mutexattr_init, pthread_mutexattr_init);
369
370 int __pthread_mutexattr_destroy(pthread_mutexattr_t *attr)
371 {
372   return 0;
373 }
374 strong_alias(__pthread_mutexattr_destroy, pthread_mutexattr_destroy);
375
376 int __pthread_mutexattr_setkind_np(pthread_mutexattr_t *attr, int kind)
377 {
378   return 0;
379 }
380 strong_alias(__pthread_mutexattr_setkind_np, pthread_mutexattr_setkind_np);
381
382 int __pthread_mutexattr_getkind_np(pthread_mutexattr_t *attr, int *kind)
383 {
384   *kind = PTHREAD_MUTEX_RECURSIVE_NP;
385   return 0;
386 }
387 strong_alias(__pthread_mutexattr_getkind_np, pthread_mutexattr_getkind_np);
388
389 int __pthread_mutexattr_settype(pthread_mutexattr_t *attr, int kind)
390 {
391   return 0;
392 }
393 strong_alias(__pthread_mutexattr_settype, pthread_mutexattr_settype);
394
395 int __pthread_mutexattr_gettype(pthread_mutexattr_t *attr, int *kind)
396 {
397   *kind = PTHREAD_MUTEX_RECURSIVE_NP;
398   return 0;
399 }
400 strong_alias(__pthread_mutexattr_gettype, pthread_mutexattr_gettype);
401
402
403 /***** THREAD-SPECIFIC VARIABLES (KEYS) *****/
404
405 int __pthread_key_create(pthread_key_t *key, void (*destr_function)(void *))
406 {
407   static LONG keycnt = FIRST_KEY;
408   *key = InterlockedExchangeAdd(&keycnt, 1);
409   return 0;
410 }
411 strong_alias(__pthread_key_create, pthread_key_create);
412
413 int __pthread_key_delete(pthread_key_t key)
414 {
415   return 0;
416 }
417 strong_alias(__pthread_key_delete, pthread_key_delete);
418
419 int __pthread_setspecific(pthread_key_t key, const void *pointer)
420 {
421   TEB *teb = NtCurrentTeb();
422   if (!teb->pthread_data) {
423     teb->pthread_data = calloc(MAX_KEYS,sizeof(key_data));
424   }
425   ((key_data*)(teb->pthread_data))[key] = pointer;
426   return 0;
427 }
428 strong_alias(__pthread_setspecific, pthread_setspecific);
429
430 void *__pthread_getspecific(pthread_key_t key)
431 {
432   TEB *teb = NtCurrentTeb();
433   if (!teb) return NULL;
434   if (!teb->pthread_data) return NULL;
435   return (void *)(((key_data*)(teb->pthread_data))[key]);
436 }
437 strong_alias(__pthread_getspecific, pthread_getspecific);
438
439
440 /***** "EXCEPTION" FRAMES *****/
441 /* not implemented right now */
442
443 void _pthread_cleanup_push(struct _pthread_cleanup_buffer *buffer, void (*routine)(void *), void *arg)
444 {
445   ((wine_cleanup)buffer)->routine = routine;
446   ((wine_cleanup)buffer)->arg = arg;
447 }
448
449 void _pthread_cleanup_pop(struct _pthread_cleanup_buffer *buffer, int execute)
450 {
451   if (execute) (*(((wine_cleanup)buffer)->routine))(((wine_cleanup)buffer)->arg);
452 }
453
454 void _pthread_cleanup_push_defer(struct _pthread_cleanup_buffer *buffer, void (*routine)(void *), void *arg)
455 {
456   _pthread_cleanup_push(buffer, routine, arg);
457 }
458
459 void _pthread_cleanup_pop_restore(struct _pthread_cleanup_buffer *buffer, int execute)
460 {
461   _pthread_cleanup_pop(buffer, execute);
462 }
463
464
465 /***** CONDITIONS *****/
466 /* not implemented right now */
467
468 int pthread_cond_init(pthread_cond_t *cond, const pthread_condattr_t *cond_attr)
469 {
470   P_OUTPUT("FIXME:pthread_cond_init\n");
471   return 0;
472 }
473
474 int pthread_cond_destroy(pthread_cond_t *cond)
475 {
476   P_OUTPUT("FIXME:pthread_cond_destroy\n");
477   return 0;
478 }
479
480 int pthread_cond_signal(pthread_cond_t *cond)
481 {
482   P_OUTPUT("FIXME:pthread_cond_signal\n");
483   return 0;
484 }
485
486 int pthread_cond_broadcast(pthread_cond_t *cond)
487 {
488   P_OUTPUT("FIXME:pthread_cond_broadcast\n");
489   return 0;
490 }
491
492 int pthread_cond_wait(pthread_cond_t *cond, pthread_mutex_t *mutex)
493 {
494   P_OUTPUT("FIXME:pthread_cond_wait\n");
495   return 0;
496 }
497
498 int pthread_cond_timedwait(pthread_cond_t *cond, pthread_mutex_t *mutex, const struct timespec *abstime)
499 {
500   P_OUTPUT("FIXME:pthread_cond_timedwait\n");
501   return 0;
502 }
503
504 /**** CONDITION ATTRIBUTES *****/
505 /* not implemented right now */
506
507 int pthread_condattr_init(pthread_condattr_t *attr)
508 {
509   return 0;
510 }
511
512 int pthread_condattr_destroy(pthread_condattr_t *attr)
513 {
514   return 0;
515 }
516
517 #if (__GLIBC__ == 2) && (__GLIBC_MINOR__ >= 2)
518 /***** READ-WRITE LOCKS *****/
519
520 static void rwlock_real_init(pthread_rwlock_t *rwlock)
521 {
522   RTL_RWLOCK *lock = HeapAlloc(GetProcessHeap(), 0, sizeof(RTL_RWLOCK));
523   RtlInitializeResource(lock);
524
525   if (InterlockedCompareExchangePointer((void**)&(((wine_rwlock)rwlock)->lock),lock,NULL) != NULL) {
526     /* too late, some other thread already did it */
527     RtlDeleteResource(lock);
528     HeapFree(GetProcessHeap(), 0, lock);
529   }
530 }
531
532 int __pthread_rwlock_init(pthread_rwlock_t *rwlock, const pthread_rwlockattr_t *rwlock_attr)
533 {
534   ((wine_rwlock)rwlock)->lock = NULL;
535   return 0;
536 }
537 strong_alias(__pthread_rwlock_init, pthread_rwlock_init);
538
539 int __pthread_rwlock_destroy(pthread_rwlock_t *rwlock)
540 {
541   if (!((wine_rwlock)rwlock)->lock) return 0;
542   RtlDeleteResource(((wine_rwlock)rwlock)->lock);
543   HeapFree(GetProcessHeap(), 0, ((wine_rwlock)rwlock)->lock);
544   return 0;
545 }
546 strong_alias(__pthread_rwlock_destroy, pthread_rwlock_destroy);
547
548 int __pthread_rwlock_rdlock(pthread_rwlock_t *rwlock)
549 {
550   if (!init_done) return 0;
551   if (!((wine_rwlock)rwlock)->lock)
552     rwlock_real_init( rwlock );
553
554   while(TRUE)
555     if (RtlAcquireResourceShared(((wine_rwlock)rwlock)->lock, TRUE))
556       return 0;
557 }
558 strong_alias(__pthread_rwlock_rdlock, pthread_rwlock_rdlock);
559
560 int __pthread_rwlock_tryrdlock(pthread_rwlock_t *rwlock)
561 {
562   if (!init_done) return 0;
563   if (!((wine_rwlock)rwlock)->lock)
564     rwlock_real_init( rwlock );
565
566   if (!RtlAcquireResourceShared(((wine_rwlock)rwlock)->lock, FALSE)) {
567     errno = EBUSY;
568     return -1;
569   }
570   return 0;
571 }
572 strong_alias(__pthread_rwlock_tryrdlock, pthread_rwlock_tryrdlock);
573
574 int __pthread_rwlock_wrlock(pthread_rwlock_t *rwlock)
575 {
576   if (!init_done) return 0;
577   if (!((wine_rwlock)rwlock)->lock)
578     rwlock_real_init( rwlock );
579
580   while(TRUE)
581     if (RtlAcquireResourceExclusive(((wine_rwlock)rwlock)->lock, TRUE))
582       return 0;
583 }
584 strong_alias(__pthread_rwlock_wrlock, pthread_rwlock_wrlock);
585
586 int __pthread_rwlock_trywrlock(pthread_rwlock_t *rwlock)
587 {
588   if (!init_done) return 0;
589   if (!((wine_rwlock)rwlock)->lock)
590     rwlock_real_init( rwlock );
591
592   if (!RtlAcquireResourceExclusive(((wine_rwlock)rwlock)->lock, FALSE)) {
593     errno = EBUSY;
594     return -1;
595   }
596   return 0;
597 }
598 strong_alias(__pthread_rwlock_trywrlock, pthread_rwlock_trywrlock);
599
600 int __pthread_rwlock_unlock(pthread_rwlock_t *rwlock)
601 {
602   if (!((wine_rwlock)rwlock)->lock) return 0;
603   RtlReleaseResource( ((wine_rwlock)rwlock)->lock );
604   return 0;
605 }
606 strong_alias(__pthread_rwlock_unlock, pthread_rwlock_unlock);
607
608 /**** READ-WRITE LOCK ATTRIBUTES *****/
609 /* not implemented right now */
610
611 int pthread_rwlockattr_init(pthread_rwlockattr_t *attr)
612 {
613   return 0;
614 }
615
616 int __pthread_rwlockattr_destroy(pthread_rwlockattr_t *attr)
617 {
618   return 0;
619 }
620 strong_alias(__pthread_rwlockattr_destroy, pthread_rwlockattr_destroy);
621
622 int pthread_rwlockattr_getkind_np(const pthread_rwlockattr_t *attr, int *pref)
623 {
624   *pref = 0;
625   return 0;
626 }
627
628 int pthread_rwlockattr_setkind_np(pthread_rwlockattr_t *attr, int pref)
629 {
630   return 0;
631 }
632 #endif /* glibc 2.2 */
633
634 /***** MISC *****/
635
636 pthread_t pthread_self(void)
637 {
638   return (pthread_t)GetCurrentThreadId();
639 }
640
641 int pthread_equal(pthread_t thread1, pthread_t thread2)
642 {
643   return (DWORD)thread1 == (DWORD)thread2;
644 }
645
646 void pthread_exit(void *retval)
647 {
648   /* FIXME: pthread cleanup */
649   ExitThread((DWORD)retval);
650 }
651
652 int pthread_setcanceltype(int type, int *oldtype)
653 {
654   if (oldtype) *oldtype = PTHREAD_CANCEL_ASYNCHRONOUS;
655   return 0;
656 }
657
658 /***** ANTI-OVERRIDES *****/
659 /* pthreads tries to override these, point them back to libc */
660
661 #ifdef jump_alias
662 jump_alias(LIBC_SIGACTION, sigaction);
663 #else
664 int sigaction(int signum, const struct sigaction *act, struct sigaction *oldact)
665 {
666   return LIBC_SIGACTION(signum, act, oldact);
667 }
668 #endif
669
670 #endif /* __GLIBC__ */