Re: [PATCH} perlio and threading @ 10576 + report
[p5sagit/p5-mst-13.2.git] / win32 / win32.h
CommitLineData
68dc0745 1/* WIN32.H
2 *
3 * (c) 1995 Microsoft Corporation. All rights reserved.
4 * Developed by hip communications inc., http://info.hip.com/info/
5 *
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
8 */
0a753a76 9#ifndef _INC_WIN32_PERL5
10#define _INC_WIN32_PERL5
11
5db10396 12#ifndef _WIN32_WINNT
13# define _WIN32_WINNT 0x0400 /* needed for TryEnterCriticalSection() etc. */
14#endif
638eceb6 15
32e30700 16#if defined(PERL_OBJECT) || defined(PERL_IMPLICIT_SYS) || defined(PERL_CAPI)
e9ee4811 17# define DYNAMIC_ENV_FETCH
18# define ENV_HV_NAME "___ENV_HV_NAME___"
a6c40364 19# define HAS_GETENV_LEN
e9ee4811 20# define prime_env_iter()
ab39fa9d 21# define WIN32IO_IS_STDIO /* don't pull in custom stdio layer */
c5be433b 22# define WIN32SCK_IS_STDSCK /* don't pull in custom wsock layer */
ab39fa9d 23# ifdef PERL_GLOBAL_STRUCT
32e30700 24# error PERL_GLOBAL_STRUCT cannot be defined with PERL_IMPLICIT_SYS
ab39fa9d 25# endif
e5a95ffb 26# define win32_get_privlib PerlEnv_lib_path
ab39fa9d 27# define win32_get_sitelib PerlEnv_sitelib_path
4ea817c6 28# define win32_get_vendorlib PerlEnv_vendorlib_path
9d8a25dc 29#endif
30
a835ef8a 31#ifdef __GNUC__
b7c82df9 32# ifndef __int64 /* some versions seem to #define it already */
33# define __int64 long long
34# endif
db15561c 35# define Win32_Winsock
a835ef8a 36#endif
37
22239a37 38/* Define DllExport akin to perl's EXT,
39 * If we are in the DLL or mimicing the DLL for Win95 work round
40 * then Export the symbol,
41 * otherwise import it.
42 */
43
5db10396 44/* now even GCC supports __declspec() */
45
c69f6586 46#if defined(PERL_OBJECT)
47#define DllExport
48#else
22239a37 49#if defined(PERLDLL) || defined(WIN95FIX)
852c2e52 50#define DllExport
51/*#define DllExport __declspec(dllexport)*/ /* noises with VC5+sp3 */
22239a37 52#else
53#define DllExport __declspec(dllimport)
54#endif
c69f6586 55#endif
c69f112c 56
0a753a76 57#define WIN32_LEAN_AND_MEAN
58#include <windows.h>
59
68dc0745 60#ifdef WIN32_LEAN_AND_MEAN /* C file is NOT a Perl5 original. */
61#define CONTEXT PERL_CONTEXT /* Avoid conflict of CONTEXT defs. */
68dc0745 62#endif /*WIN32_LEAN_AND_MEAN */
0a753a76 63
eda5ff31 64#ifndef TLS_OUT_OF_INDEXES
65#define TLS_OUT_OF_INDEXES (DWORD)0xFFFFFFFF
66#endif
67
0a753a76 68#include <dirent.h>
69#include <io.h>
70#include <process.h>
71#include <stdio.h>
72#include <direct.h>
390b85e7 73#include <stdlib.h>
7a1f88ac 74#include <fcntl.h>
390b85e7 75#ifndef EXT
76#include "EXTERN.h"
77#endif
78
c69f112c 79struct tms {
80 long tms_utime;
81 long tms_stime;
82 long tms_cutime;
83 long tms_cstime;
84};
85
b2af26b1 86#ifndef SYS_NMLN
87#define SYS_NMLN 257
88#endif
89
90struct utsname {
91 char sysname[SYS_NMLN];
92 char nodename[SYS_NMLN];
93 char release[SYS_NMLN];
94 char version[SYS_NMLN];
95 char machine[SYS_NMLN];
96};
97
390b85e7 98#ifndef START_EXTERN_C
b3e5c95e 99#undef EXTERN_C
390b85e7 100#ifdef __cplusplus
101# define START_EXTERN_C extern "C" {
102# define END_EXTERN_C }
103# define EXTERN_C extern "C"
104#else
105# define START_EXTERN_C
106# define END_EXTERN_C
107# define EXTERN_C
108#endif
109#endif
110
111#define STANDARD_C 1
112#define DOSISH 1 /* no escaping our roots */
113#define OP_BINARY O_BINARY /* mistake in in pp_sys.c? */
0a753a76 114
f3986ebb 115/* Define USE_SOCKETS_AS_HANDLES to enable emulation of windows sockets as
116 * real filehandles. XXX Should always be defined (the other version is untested) */
117#define USE_SOCKETS_AS_HANDLES
118
a7092146 119/* read() and write() aren't transparent for socket handles */
120#define PERL_SOCK_SYSREAD_IS_RECV
121#define PERL_SOCK_SYSWRITE_IS_SEND
122
682fc664 123#define PERL_NO_FORCE_LINK /* no need for PL_force_link_funcs */
a7092146 124
9e5f57de 125/* Define USE_FIXED_OSFHANDLE to fix MSVCRT's _open_osfhandle() on W95.
126 It now uses some black magic to work seamlessly with the DLL CRT and
127 works with MSVC++ 4.0+ or GCC/Mingw32
128 -- BKS 1-24-2000 */
129#if (defined(_M_IX86) && _MSC_VER >= 1000) || defined(__MINGW32__)
f3986ebb 130#define USE_FIXED_OSFHANDLE
131#endif
132
6940069f 133/* Define PERL_WIN32_SOCK_DLOAD to have Perl dynamically load the winsock
134 DLL when needed. Don't use if your compiler supports delayloading (ie, VC++ 6.0)
135 -- BKS 5-29-2000 */
136#if !(defined(_M_IX86) && _MSC_VER >= 1200)
137#define PERL_WIN32_SOCK_DLOAD
138#endif
902173a3 139#define ENV_IS_CASELESS
140
d41de25a 141#ifndef VER_PLATFORM_WIN32_WINDOWS /* VC-2.0 headers don't have this */
f3986ebb 142#define VER_PLATFORM_WIN32_WINDOWS 1
143#endif
144
d41de25a 145#ifndef FILE_SHARE_DELETE /* VC-4.0 headers don't have this */
146#define FILE_SHARE_DELETE 0x00000004
147#endif
148
327c3667 149/* access() mode bits */
150#ifndef R_OK
151# define R_OK 4
152# define W_OK 2
153# define X_OK 1
154# define F_OK 0
155#endif
156
cc236deb 157/* for waitpid() */
158#ifndef WNOHANG
159# define WNOHANG 1
160#endif
161
c44d3fdb 162#define PERL_GET_CONTEXT_DEFINED
163
f3986ebb 164/* Compiler-specific stuff. */
165
910dfcc8 166#ifdef __BORLANDC__ /* Borland C++ */
3e3baf6d 167
cb359b41 168#if (__BORLANDC__ <= 0x520)
3e3baf6d 169#define _access access
170#define _chdir chdir
cb359b41 171#endif
172
4ce4f76e 173#define _getpid getpid
26871e0a 174#define wcsicmp _wcsicmp
3e3baf6d 175#include <sys/types.h>
176
84902520 177#ifndef DllMain
178#define DllMain DllEntryPoint
179#endif
180
189b2af5 181#pragma warn -ccc /* "condition is always true/false" */
182#pragma warn -rch /* "unreachable code" */
183#pragma warn -sig /* "conversion may lose significant digits" */
184#pragma warn -pia /* "possibly incorrect assignment" */
185#pragma warn -par /* "parameter 'foo' is never used" */
186#pragma warn -aus /* "'foo' is assigned a value that is never used" */
187#pragma warn -use /* "'foo' is declared but never used" */
188#pragma warn -csu /* "comparing signed and unsigned values" */
3e3baf6d 189
ac4c12e7 190/* Borland is picky about a bare member function name used as its ptr */
191#ifdef PERL_OBJECT
0b94c7bb 192# define MEMBER_TO_FPTR(name) &(name)
ac4c12e7 193#endif
194
cd183fd9 195/* Borland C thinks that a pointer to a member variable is 12 bytes in size. */
196#define PERL_MEMBER_PTR_SIZE 12
197
1307044d 198#define isnan _isnan
199
910dfcc8 200#endif
3e3baf6d 201
f3986ebb 202#ifdef _MSC_VER /* Microsoft Visual C++ */
203
0a753a76 204typedef long uid_t;
205typedef long gid_t;
a6c40364 206typedef unsigned short mode_t;
f3986ebb 207#pragma warning(disable: 4018 4035 4101 4102 4244 4245 4761)
208
0f4eea8f 209/* Visual C thinks that a pointer to a member variable is 16 bytes in size. */
cd183fd9 210#define PERL_MEMBER_PTR_SIZE 16
0f4eea8f 211
5fb4d820 212#define isnan _isnan
213
f3986ebb 214#endif /* _MSC_VER */
215
910dfcc8 216#ifdef __MINGW32__ /* Minimal Gnu-Win32 */
217
218typedef long uid_t;
219typedef long gid_t;
b1d1613b 220#ifndef _environ
3730b96e 221#define _environ environ
b1d1613b 222#endif
3730b96e 223#define flushall _flushall
224#define fcloseall _fcloseall
6940069f 225#define isnan _isnan /* ...same libraries as MSVC */
910dfcc8 226
db15561c 227#ifdef PERL_OBJECT
0b94c7bb 228# define MEMBER_TO_FPTR(name) &(name)
db15561c 229#endif
230
ac4c12e7 231#ifndef _O_NOINHERIT
232# define _O_NOINHERIT 0x0080
233# ifndef _NO_OLDNAMES
234# define O_NOINHERIT _O_NOINHERIT
235# endif
236#endif
237
910dfcc8 238#endif /* __MINGW32__ */
239
f8fb7c90 240/* both GCC/Mingw32 and MSVC++ 4.0 are missing this, so we put it here */
241#ifndef CP_UTF8
242# define CP_UTF8 65001
243#endif
244
f3986ebb 245/* compatibility stuff for other compilers goes here */
0a753a76 246
0a753a76 247
dfdd1393 248#if !defined(PERL_OBJECT) && defined(PERL_CAPI) && defined(PERL_MEMBER_PTR_SIZE)
cd183fd9 249# define STRUCT_MGVTBL_DEFINITION \
250struct mgvtbl { \
251 union { \
252 int (CPERLscope(*svt_get))(pTHX_ SV *sv, MAGIC* mg); \
253 char handle_VC_problem1[PERL_MEMBER_PTR_SIZE]; \
254 }; \
255 union { \
256 int (CPERLscope(*svt_set))(pTHX_ SV *sv, MAGIC* mg); \
257 char handle_VC_problem2[PERL_MEMBER_PTR_SIZE]; \
258 }; \
259 union { \
260 U32 (CPERLscope(*svt_len))(pTHX_ SV *sv, MAGIC* mg); \
261 char handle_VC_problem3[PERL_MEMBER_PTR_SIZE]; \
262 }; \
263 union { \
264 int (CPERLscope(*svt_clear))(pTHX_ SV *sv, MAGIC* mg); \
265 char handle_VC_problem4[PERL_MEMBER_PTR_SIZE]; \
266 }; \
267 union { \
268 int (CPERLscope(*svt_free))(pTHX_ SV *sv, MAGIC* mg); \
269 char handle_VC_problem5[PERL_MEMBER_PTR_SIZE]; \
270 }; \
271}
272
273# define BASEOP_DEFINITION \
274 OP* op_next; \
275 OP* op_sibling; \
276 OP* (CPERLscope(*op_ppaddr))(pTHX); \
277 char handle_VC_problem[PERL_MEMBER_PTR_SIZE-sizeof(OP*)]; \
278 PADOFFSET op_targ; \
279 OPCODE op_type; \
280 U16 op_seq; \
281 U8 op_flags; \
282 U8 op_private;
283
dfdd1393 284#endif /* !PERL_OBJECT && PERL_CAPI && PERL_MEMBER_PTR_SIZE */
cd183fd9 285
286
390b85e7 287START_EXTERN_C
f3986ebb 288
289/* For UNIX compatibility. */
290
0a753a76 291extern uid_t getuid(void);
292extern gid_t getgid(void);
293extern uid_t geteuid(void);
294extern gid_t getegid(void);
0a753a76 295extern int setuid(uid_t uid);
296extern int setgid(gid_t gid);
297extern int kill(int pid, int sig);
161b471a 298extern void *sbrk(int need);
e34ffe5a 299extern char * getlogin(void);
b990f8c8 300extern int chown(const char *p, uid_t o, gid_t g);
00b02797 301extern int mkstemp(const char *path);
d55594ae 302
f3986ebb 303#undef Stat
304#define Stat win32_stat
3e3baf6d 305
f3986ebb 306#undef init_os_extras
307#define init_os_extras Perl_init_os_extras
390b85e7 308
22239a37 309DllExport void Perl_win32_init(int *argcp, char ***argvp);
cb359b41 310DllExport void Perl_init_os_extras(void);
c5be433b 311DllExport void win32_str_os_error(void *sv, DWORD err);
312DllExport int RunPerl(int argc, char **argv, char **env);
0551aaa8 313
635bbe87 314typedef struct {
315 HANDLE childStdIn;
316 HANDLE childStdOut;
317 HANDLE childStdErr;
f83751a7 318 /*
319 * the following correspond to the fields of the same name
320 * in the STARTUPINFO structure. Embedders can use these to
321 * control the spawning process' look.
322 * Example - to hide the window of the spawned process:
323 * dwFlags = STARTF_USESHOWWINDOW;
324 * wShowWindow = SW_HIDE;
325 */
326 DWORD dwFlags;
327 DWORD dwX;
328 DWORD dwY;
329 DWORD dwXSize;
330 DWORD dwYSize;
331 DWORD dwXCountChars;
332 DWORD dwYCountChars;
333 DWORD dwFillAttribute;
334 WORD wShowWindow;
635bbe87 335} child_IO_table;
336
337DllExport void win32_get_child_IO(child_IO_table* ptr);
338
f3986ebb 339#ifndef USE_SOCKETS_AS_HANDLES
340extern FILE * my_fdopen(int, char *);
d55594ae 341#endif
f3986ebb 342extern int my_fclose(FILE *);
ed59ec62 343extern int my_fstat(int fd, struct stat *sbufptr);
c5be433b 344extern int do_aspawn(void *really, void **mark, void **sp);
345extern int do_spawn(char *cmd);
346extern int do_spawn_nowait(char *cmd);
4ea817c6 347extern char * win32_get_privlib(const char *pl);
348extern char * win32_get_sitelib(const char *pl);
349extern char * win32_get_vendorlib(const char *pl);
f3986ebb 350extern int IsWin95(void);
351extern int IsWinNT(void);
c0932edc 352extern void win32_argv2utf8(int argc, char** argv);
d55594ae 353
1c0ca838 354#ifdef PERL_IMPLICIT_SYS
355extern void win32_delete_internal_host(void *h);
356#endif
357
f3986ebb 358extern char * staticlinkmodules[];
390b85e7 359
360END_EXTERN_C
d55594ae 361
68dc0745 362typedef char * caddr_t; /* In malloc.c (core address). */
0a753a76 363
68dc0745 364/*
68dc0745 365 * handle socket stuff, assuming socket is always available
366 */
0a753a76 367#include <sys/socket.h>
368#include <netdb.h>
369
bbc8f9de 370#ifdef MYMALLOC
371#define EMBEDMYMALLOC /**/
372/* #define USE_PERL_SBRK /**/
373/* #define PERL_SBRK_VIA_MALLOC /**/
374#endif
375
c31fac66 376#if defined(PERLDLL) && !defined(PERL_CORE)
bbc8f9de 377#define PERL_CORE
378#endif
379
e68cb057 380#ifdef PERL_TEXTMODE_SCRIPTS
c39cd008 381# define PERL_SCRIPT_MODE "r"
a868473f 382#else
c39cd008 383# define PERL_SCRIPT_MODE "rb"
a868473f 384#endif
385
3352bfcb 386/*
387 * Now Win32 specific per-thread data stuff
388 */
389
390struct thread_intern {
391 /* XXX can probably use one buffer instead of several */
392 char Wstrerror_buffer[512];
393 struct servent Wservent;
394 char Wgetlogin_buffer[128];
395# ifdef USE_SOCKETS_AS_HANDLES
396 int Winit_socktype;
397# endif
398# ifdef HAVE_DES_FCRYPT
399 char Wcrypt_buffer[30];
400# endif
401# ifdef USE_RTL_THREAD_API
402 void * retv; /* slot for thread return value */
403# endif
404};
405
406#ifdef USE_THREADS
407# ifndef USE_DECLSPEC_THREAD
408# define HAVE_THREAD_INTERN
409# endif /* !USE_DECLSPEC_THREAD */
410#endif /* USE_THREADS */
411
4b556e6c 412#define HAVE_INTERP_INTERN
0aaad0ff 413typedef struct {
414 long num;
415 DWORD pids[MAXIMUM_WAIT_OBJECTS];
7766f137 416 HANDLE handles[MAXIMUM_WAIT_OBJECTS];
0aaad0ff 417} child_tab;
418
4b556e6c 419struct interp_intern {
0aaad0ff 420 char * perlshell_tokens;
421 char ** perlshell_vec;
422 long perlshell_items;
423 struct av * fdpid;
424 child_tab * children;
7766f137 425#ifdef USE_ITHREADS
426 DWORD pseudo_id;
427 child_tab * pseudo_children;
428#endif
429 void * internal_host;
3352bfcb 430#ifndef USE_THREADS
431 struct thread_intern thr_intern;
432#endif
4b556e6c 433};
434
4b556e6c 435
0aaad0ff 436#define w32_perlshell_tokens (PL_sys_intern.perlshell_tokens)
437#define w32_perlshell_vec (PL_sys_intern.perlshell_vec)
438#define w32_perlshell_items (PL_sys_intern.perlshell_items)
439#define w32_fdpid (PL_sys_intern.fdpid)
440#define w32_children (PL_sys_intern.children)
441#define w32_num_children (w32_children->num)
442#define w32_child_pids (w32_children->pids)
7766f137 443#define w32_child_handles (w32_children->handles)
444#define w32_pseudo_id (PL_sys_intern.pseudo_id)
445#define w32_pseudo_children (PL_sys_intern.pseudo_children)
446#define w32_num_pseudo_children (w32_pseudo_children->num)
447#define w32_pseudo_child_pids (w32_pseudo_children->pids)
448#define w32_pseudo_child_handles (w32_pseudo_children->handles)
449#define w32_internal_host (PL_sys_intern.internal_host)
c53bd28a 450#ifdef USE_THREADS
3352bfcb 451# define w32_strerror_buffer (thr->i.Wstrerror_buffer)
452# define w32_getlogin_buffer (thr->i.Wgetlogin_buffer)
453# define w32_crypt_buffer (thr->i.Wcrypt_buffer)
454# define w32_servent (thr->i.Wservent)
455# define w32_init_socktype (thr->i.Winit_socktype)
456#else
457# define w32_strerror_buffer (PL_sys_intern.thr_intern.Wstrerror_buffer)
458# define w32_getlogin_buffer (PL_sys_intern.thr_intern.Wgetlogin_buffer)
459# define w32_crypt_buffer (PL_sys_intern.thr_intern.Wcrypt_buffer)
460# define w32_servent (PL_sys_intern.thr_intern.Wservent)
461# define w32_init_socktype (PL_sys_intern.thr_intern.Winit_socktype)
e34ffe5a 462#endif /* USE_THREADS */
c53bd28a 463
7fac1903 464/* UNICODE<>ANSI translation helpers */
465/* Use CP_ACP when mode is ANSI */
466/* Use CP_UTF8 when mode is UTF8 */
467
e9ff6d27 468#define A2WHELPER_LEN(lpa, alen, lpw, nBytes)\
c8f3d7f8 469 (lpw[0] = 0, MultiByteToWideChar((IN_BYTES) ? CP_ACP : CP_UTF8, 0, \
e9ff6d27 470 lpa, alen, lpw, (nBytes/sizeof(WCHAR))))
471#define A2WHELPER(lpa, lpw, nBytes) A2WHELPER_LEN(lpa, -1, lpw, nBytes)
472
473#define W2AHELPER_LEN(lpw, wlen, lpa, nChars)\
c8f3d7f8 474 (lpa[0] = '\0', WideCharToMultiByte((IN_BYTES) ? CP_ACP : CP_UTF8, 0, \
e9ff6d27 475 lpw, wlen, (LPSTR)lpa, nChars,NULL,NULL))
476#define W2AHELPER(lpw, lpa, nChars) W2AHELPER_LEN(lpw, -1, lpa, nChars)
7fac1903 477
46487f74 478#define USING_WIDE() (PL_widesyscalls && PerlEnv_os_id() == VER_PLATFORM_WIN32_NT)
7fac1903 479
7766f137 480#ifdef USE_ITHREADS
481# define PERL_WAIT_FOR_CHILDREN \
482 STMT_START { \
483 if (w32_pseudo_children && w32_num_pseudo_children) { \
484 long children = w32_num_pseudo_children; \
485 WaitForMultipleObjects(children, \
486 w32_pseudo_child_handles, \
487 TRUE, INFINITE); \
488 while (children) \
489 CloseHandle(w32_pseudo_child_handles[--children]); \
490 } \
491 } STMT_END
492#endif
493
a10b7b7e 494#if defined(USE_FIXED_OSFHANDLE) || defined(PERL_MSVCRT_READFIX)
495#ifdef PERL_CORE
496
497/* C doesn't like repeat struct definitions */
498#ifndef _CRTIMP
499#define _CRTIMP __declspec(dllimport)
500#endif
501
502/*
503 * Control structure for lowio file handles
504 */
505typedef struct {
506 long osfhnd; /* underlying OS file HANDLE */
507 char osfile; /* attributes of file (e.g., open in text mode?) */
508 char pipech; /* one char buffer for handles opened on pipes */
509 int lockinitflag;
510 CRITICAL_SECTION lock;
511} ioinfo;
512
513
514/*
515 * Array of arrays of control structures for lowio files.
516 */
517EXTERN_C _CRTIMP ioinfo* __pioinfo[];
518
519/*
520 * Definition of IOINFO_L2E, the log base 2 of the number of elements in each
521 * array of ioinfo structs.
522 */
523#define IOINFO_L2E 5
524
525/*
526 * Definition of IOINFO_ARRAY_ELTS, the number of elements in ioinfo array
527 */
528#define IOINFO_ARRAY_ELTS (1 << IOINFO_L2E)
529
530/*
531 * Access macros for getting at an ioinfo struct and its fields from a
532 * file handle
533 */
534#define _pioinfo(i) (__pioinfo[(i) >> IOINFO_L2E] + ((i) & (IOINFO_ARRAY_ELTS - 1)))
535#define _osfhnd(i) (_pioinfo(i)->osfhnd)
536#define _osfile(i) (_pioinfo(i)->osfile)
537#define _pipech(i) (_pioinfo(i)->pipech)
538
539/* since we are not doing a dup2(), this works fine */
540#define _set_osfhnd(fh, osfh) (void)(_osfhnd(fh) = (long)osfh)
541#endif
542#endif
543
adb71456 544#define PERLIO_NOT_STDIO 0
545
546#include "perlio.h"
547
4f63d024 548/*
549 * This provides a layer of functions and macros to ensure extensions will
550 * get to use the same RTL functions as the core.
551 */
552#include "win32iop.h"
553
b4748376 554#define EXEC_ARGV_CAST(x) ((const char *const *) x)
555
68dc0745 556#endif /* _INC_WIN32_PERL5 */
7a9ec5a3 557