This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
[PATCH: perl@11564] introducing perlivp
[perl5.git] / win32 / win32thread.h
CommitLineData
d55594ae
GS
1#ifndef _WIN32THREAD_H
2#define _WIN32THREAD_H
4f63d024 3
7766f137 4#include "win32.h"
4f63d024 5
d55594ae 6typedef struct win32_cond { LONG waiters; HANDLE sem; } perl_cond;
ea0efc06 7typedef DWORD perl_key;
51dd5992 8typedef HANDLE perl_os_thread;
ea0efc06 9
4b026b9e
GS
10#ifndef DONT_USE_CRITICAL_SECTION
11
12/* Critical Sections used instead of mutexes: lightweight,
ea0efc06 13 * but can't be communicated to child processes, and can't get
4b026b9e 14 * HANDLE to it for use elsewhere.
ea0efc06 15 */
d55594ae 16typedef CRITICAL_SECTION perl_mutex;
ea0efc06
MB
17#define MUTEX_INIT(m) InitializeCriticalSection(m)
18#define MUTEX_LOCK(m) EnterCriticalSection(m)
19#define MUTEX_UNLOCK(m) LeaveCriticalSection(m)
20#define MUTEX_DESTROY(m) DeleteCriticalSection(m)
4b026b9e 21
d55594ae 22#else
ea0efc06 23
4b026b9e 24typedef HANDLE perl_mutex;
ba869deb 25# define MUTEX_INIT(m) \
ea0efc06
MB
26 STMT_START { \
27 if ((*(m) = CreateMutex(NULL,FALSE,NULL)) == NULL) \
efc57feb 28 Perl_croak_nocontext("panic: MUTEX_INIT"); \
ea0efc06 29 } STMT_END
ba869deb
GS
30
31# define MUTEX_LOCK(m) \
ea0efc06
MB
32 STMT_START { \
33 if (WaitForSingleObject(*(m),INFINITE) == WAIT_FAILED) \
4f63d024
GS
34 Perl_croak_nocontext("panic: MUTEX_LOCK"); \
35 } STMT_END
ba869deb 36
efc57feb 37# define MUTEX_UNLOCK(m) \
4f63d024
GS
38 STMT_START { \
39 if (ReleaseMutex(*(m)) == 0) \
40 Perl_croak_nocontext("panic: MUTEX_UNLOCK"); \
ea0efc06 41 } STMT_END
ba869deb
GS
42
43# define MUTEX_DESTROY(m) \
ea0efc06
MB
44 STMT_START { \
45 if (CloseHandle(*(m)) == 0) \
efc57feb 46 Perl_croak_nocontext("panic: MUTEX_DESTROY"); \
ea0efc06
MB
47 } STMT_END
48
d55594ae
GS
49#endif
50
51/* These macros assume that the mutex associated with the condition
52 * will always be held before COND_{SIGNAL,BROADCAST,WAIT,DESTROY},
53 * so there's no separate mutex protecting access to (c)->waiters
54 */
ea0efc06 55#define COND_INIT(c) \
4b026b9e
GS
56 STMT_START { \
57 (c)->waiters = 0; \
58 (c)->sem = CreateSemaphore(NULL,0,LONG_MAX,NULL); \
59 if ((c)->sem == NULL) \
efc57feb 60 Perl_croak_nocontext("panic: COND_INIT (%ld)",GetLastError()); \
ea0efc06 61 } STMT_END
d55594ae 62
ea0efc06 63#define COND_SIGNAL(c) \
4b026b9e
GS
64 STMT_START { \
65 if ((c)->waiters > 0 && \
66 ReleaseSemaphore((c)->sem,1,NULL) == 0) \
efc57feb 67 Perl_croak_nocontext("panic: COND_SIGNAL (%ld)",GetLastError()); \
ea0efc06 68 } STMT_END
d55594ae 69
ea0efc06 70#define COND_BROADCAST(c) \
4b026b9e
GS
71 STMT_START { \
72 if ((c)->waiters > 0 && \
73 ReleaseSemaphore((c)->sem,(c)->waiters,NULL) == 0) \
efc57feb 74 Perl_croak_nocontext("panic: COND_BROADCAST (%ld)",GetLastError());\
ea0efc06 75 } STMT_END
d55594ae 76
ea0efc06 77#define COND_WAIT(c, m) \
4b026b9e
GS
78 STMT_START { \
79 (c)->waiters++; \
80 MUTEX_UNLOCK(m); \
81 /* Note that there's no race here, since a \
82 * COND_BROADCAST() on another thread will have seen the\
83 * right number of waiters (i.e. including this one) */ \
84 if (WaitForSingleObject((c)->sem,INFINITE)==WAIT_FAILED)\
efc57feb 85 Perl_croak_nocontext("panic: COND_WAIT (%ld)",GetLastError()); \
4b026b9e
GS
86 /* XXX there may be an inconsequential race here */ \
87 MUTEX_LOCK(m); \
88 (c)->waiters--; \
ea0efc06 89 } STMT_END
d55594ae 90
ea0efc06 91#define COND_DESTROY(c) \
4b026b9e
GS
92 STMT_START { \
93 (c)->waiters = 0; \
94 if (CloseHandle((c)->sem) == 0) \
efc57feb 95 Perl_croak_nocontext("panic: COND_DESTROY (%ld)",GetLastError()); \
ea0efc06
MB
96 } STMT_END
97
98#define DETACH(t) \
99 STMT_START { \
46930d8f 100 if (CloseHandle((t)->self) == 0) { \
ea0efc06 101 MUTEX_UNLOCK(&(t)->mutex); \
efc57feb 102 Perl_croak_nocontext("panic: DETACH"); \
ea0efc06
MB
103 } \
104 } STMT_END
105
9811a7d7 106
d55594ae
GS
107#define THREAD_CREATE(t, f) Perl_thread_create(t, f)
108#define THREAD_POST_CREATE(t) NOOP
2d7a9237
GS
109
110/* XXX Docs mention that the RTL versions of thread creation routines
111 * should be used, but that advice only seems applicable when the RTL
112 * is not in a DLL. RTL DLLs in both Borland and VC seem to do all of
113 * the init/deinit required upon DLL_THREAD_ATTACH/DETACH. So we seem
114 * to be completely safe using straight Win32 API calls, rather than
115 * the much braindamaged RTL calls.
116 *
117 * _beginthread() in the RTLs call CloseHandle() just after the thread
118 * function returns, which means: 1) we have a race on our hands
119 * 2) it is impossible to implement join() semantics.
120 *
121 * IOW, do *NOT* turn on USE_RTL_THREAD_API! It is here
122 * for experimental purposes only. GSAR 98-01-02
123 */
124#ifdef USE_RTL_THREAD_API
125# include <process.h>
126# if defined(__BORLANDC__)
127 /* Borland RTL doesn't allow a return value from thread function! */
128# define THREAD_RET_TYPE void _USERENTRY
129# define THREAD_RET_CAST(p) ((void)(thr->i.retv = (void *)(p)))
130# elif defined (_MSC_VER)
131# define THREAD_RET_TYPE unsigned __stdcall
132# define THREAD_RET_CAST(p) ((unsigned)(p))
133# else
134 /* CRTDLL.DLL doesn't allow a return value from thread function! */
135# define THREAD_RET_TYPE void __cdecl
136# define THREAD_RET_CAST(p) ((void)(thr->i.retv = (void *)(p)))
137# endif
138#else /* !USE_RTL_THREAD_API */
139# define THREAD_RET_TYPE DWORD WINAPI
140# define THREAD_RET_CAST(p) ((DWORD)(p))
141#endif /* !USE_RTL_THREAD_API */
ea0efc06 142
d55594ae
GS
143typedef THREAD_RET_TYPE thread_func_t(void *);
144
0fefa03b 145
d55594ae 146START_EXTERN_C
0fefa03b 147
c69f112c 148#if defined(PERLDLL) && defined(USE_DECLSPEC_THREAD) && (!defined(__BORLANDC__) || defined(_DLL))
ba869deb
GS
149extern __declspec(thread) void *PL_current_context;
150#define PERL_SET_CONTEXT(t) (PL_current_context = t)
151#define PERL_GET_CONTEXT PL_current_context
0fefa03b 152#else
ba869deb
GS
153#define PERL_GET_CONTEXT Perl_get_context()
154#define PERL_SET_CONTEXT(t) Perl_set_context(t)
0fefa03b
NIS
155#endif
156
ba869deb
GS
157#if defined(USE_THREADS)
158struct perl_thread;
20ce7b12
GS
159int Perl_thread_create (struct perl_thread *thr, thread_func_t *fn);
160void Perl_set_thread_self (struct perl_thread *thr);
20ce7b12 161void Perl_init_thread_intern (struct perl_thread *t);
0fefa03b 162
ba869deb
GS
163#define SET_THREAD_SELF(thr) Perl_set_thread_self(thr)
164
165#endif /* USE_THREADS */
166
d55594ae
GS
167END_EXTERN_C
168
ba869deb
GS
169#define INIT_THREADS NOOP
170#define ALLOC_THREAD_KEY \
171 STMT_START { \
c44d3fdb 172 if ((PL_thr_key = TlsAlloc()) == TLS_OUT_OF_INDEXES) { \
adb71456 173 PerlIO_printf(PerlIO_stderr(),"panic: TlsAlloc"); \
c44d3fdb
GS
174 exit(1); \
175 } \
ba869deb 176 } STMT_END
ea0efc06 177
e1b5da64
GS
178#define FREE_THREAD_KEY \
179 STMT_START { \
180 TlsFree(PL_thr_key); \
181 } STMT_END
182
50dd6e57
GS
183#define PTHREAD_ATFORK(prepare,parent,child) NOOP
184
2d7a9237
GS
185#if defined(USE_RTL_THREAD_API) && !defined(_MSC_VER)
186#define JOIN(t, avp) \
187 STMT_START { \
188 if ((WaitForSingleObject((t)->self,INFINITE) == WAIT_FAILED) \
8e11982f
GS
189 || (GetExitCodeThread((t)->self,(LPDWORD)(avp)) == 0) \
190 || (CloseHandle((t)->self) == 0)) \
efc57feb 191 Perl_croak_nocontext("panic: JOIN"); \
2d7a9237
GS
192 *avp = (AV *)((t)->i.retv); \
193 } STMT_END
194#else /* !USE_RTL_THREAD_API || _MSC_VER */
ea0efc06
MB
195#define JOIN(t, avp) \
196 STMT_START { \
46930d8f 197 if ((WaitForSingleObject((t)->self,INFINITE) == WAIT_FAILED) \
8e11982f
GS
198 || (GetExitCodeThread((t)->self,(LPDWORD)(avp)) == 0) \
199 || (CloseHandle((t)->self) == 0)) \
efc57feb 200 Perl_croak_nocontext("panic: JOIN"); \
ea0efc06 201 } STMT_END
2d7a9237 202#endif /* !USE_RTL_THREAD_API || _MSC_VER */
ea0efc06 203
ea0efc06 204#define YIELD Sleep(0)
d55594ae
GS
205
206#endif /* _WIN32THREAD_H */
0fefa03b 207