Re: Making IO::Socket pass test on Win32
[p5sagit/p5-mst-13.2.git] / win32 / win32.h
CommitLineData
68dc0745 1/* WIN32.H
2 *
3fadfdf1 3 * (c) 1995 Microsoft Corporation. All rights reserved.
68dc0745 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
acfe0abc 16#if defined(PERL_IMPLICIT_SYS)
e9ee4811 17# define DYNAMIC_ENV_FETCH
a6c40364 18# define HAS_GETENV_LEN
e9ee4811 19# define prime_env_iter()
ab39fa9d 20# define WIN32IO_IS_STDIO /* don't pull in custom stdio layer */
c5be433b 21# define WIN32SCK_IS_STDSCK /* don't pull in custom wsock layer */
ab39fa9d 22# ifdef PERL_GLOBAL_STRUCT
32e30700 23# error PERL_GLOBAL_STRUCT cannot be defined with PERL_IMPLICIT_SYS
ab39fa9d 24# endif
e5a95ffb 25# define win32_get_privlib PerlEnv_lib_path
ab39fa9d 26# define win32_get_sitelib PerlEnv_sitelib_path
4ea817c6 27# define win32_get_vendorlib PerlEnv_vendorlib_path
9d8a25dc 28#endif
29
a835ef8a 30#ifdef __GNUC__
b7c82df9 31# ifndef __int64 /* some versions seem to #define it already */
32# define __int64 long long
33# endif
db15561c 34# define Win32_Winsock
1c85e96a 35#ifdef __cplusplus
36/* Mingw32 gcc -xc++ objects to __attribute((unused)) at least */
3fadfdf1 37#undef PERL_UNUSED_DECL
38#define PERL_UNUSED_DECL
a835ef8a 39#endif
1c85e96a 40#endif
41
a835ef8a 42
3fadfdf1 43/* Define DllExport akin to perl's EXT,
22239a37 44 * If we are in the DLL or mimicing the DLL for Win95 work round
3fadfdf1 45 * then Export the symbol,
22239a37 46 * otherwise import it.
47 */
48
5db10396 49/* now even GCC supports __declspec() */
50
22239a37 51#if defined(PERLDLL) || defined(WIN95FIX)
852c2e52 52#define DllExport
53/*#define DllExport __declspec(dllexport)*/ /* noises with VC5+sp3 */
3fadfdf1 54#else
22239a37 55#define DllExport __declspec(dllimport)
56#endif
c69f112c 57
0a753a76 58#define WIN32_LEAN_AND_MEAN
59#include <windows.h>
60
68dc0745 61#ifdef WIN32_LEAN_AND_MEAN /* C file is NOT a Perl5 original. */
62#define CONTEXT PERL_CONTEXT /* Avoid conflict of CONTEXT defs. */
68dc0745 63#endif /*WIN32_LEAN_AND_MEAN */
0a753a76 64
eda5ff31 65#ifndef TLS_OUT_OF_INDEXES
66#define TLS_OUT_OF_INDEXES (DWORD)0xFFFFFFFF
67#endif
68
0a753a76 69#include <dirent.h>
70#include <io.h>
71#include <process.h>
72#include <stdio.h>
73#include <direct.h>
390b85e7 74#include <stdlib.h>
c623ac67 75#include <stddef.h>
7a1f88ac 76#include <fcntl.h>
390b85e7 77#ifndef EXT
78#include "EXTERN.h"
79#endif
80
c69f112c 81struct tms {
82 long tms_utime;
83 long tms_stime;
84 long tms_cutime;
85 long tms_cstime;
86};
87
b2af26b1 88#ifndef SYS_NMLN
89#define SYS_NMLN 257
90#endif
91
92struct utsname {
93 char sysname[SYS_NMLN];
94 char nodename[SYS_NMLN];
95 char release[SYS_NMLN];
96 char version[SYS_NMLN];
97 char machine[SYS_NMLN];
98};
99
390b85e7 100#ifndef START_EXTERN_C
b3e5c95e 101#undef EXTERN_C
390b85e7 102#ifdef __cplusplus
103# define START_EXTERN_C extern "C" {
104# define END_EXTERN_C }
105# define EXTERN_C extern "C"
106#else
3fadfdf1 107# define START_EXTERN_C
108# define END_EXTERN_C
390b85e7 109# define EXTERN_C
110#endif
111#endif
112
113#define STANDARD_C 1
114#define DOSISH 1 /* no escaping our roots */
115#define OP_BINARY O_BINARY /* mistake in in pp_sys.c? */
0a753a76 116
f3986ebb 117/* Define USE_SOCKETS_AS_HANDLES to enable emulation of windows sockets as
118 * real filehandles. XXX Should always be defined (the other version is untested) */
119#define USE_SOCKETS_AS_HANDLES
120
a7092146 121/* read() and write() aren't transparent for socket handles */
122#define PERL_SOCK_SYSREAD_IS_RECV
123#define PERL_SOCK_SYSWRITE_IS_SEND
124
682fc664 125#define PERL_NO_FORCE_LINK /* no need for PL_force_link_funcs */
a7092146 126
9e5f57de 127/* Define USE_FIXED_OSFHANDLE to fix MSVCRT's _open_osfhandle() on W95.
128 It now uses some black magic to work seamlessly with the DLL CRT and
129 works with MSVC++ 4.0+ or GCC/Mingw32
130 -- BKS 1-24-2000 */
131#if (defined(_M_IX86) && _MSC_VER >= 1000) || defined(__MINGW32__)
f3986ebb 132#define USE_FIXED_OSFHANDLE
133#endif
134
6940069f 135/* Define PERL_WIN32_SOCK_DLOAD to have Perl dynamically load the winsock
136 DLL when needed. Don't use if your compiler supports delayloading (ie, VC++ 6.0)
137 -- BKS 5-29-2000 */
138#if !(defined(_M_IX86) && _MSC_VER >= 1200)
139#define PERL_WIN32_SOCK_DLOAD
140#endif
902173a3 141#define ENV_IS_CASELESS
142
479b2847 143#define PIPESOCK_MODE "b" /* pipes, sockets default to binmode */
144
d41de25a 145#ifndef VER_PLATFORM_WIN32_WINDOWS /* VC-2.0 headers don't have this */
f3986ebb 146#define VER_PLATFORM_WIN32_WINDOWS 1
147#endif
148
d41de25a 149#ifndef FILE_SHARE_DELETE /* VC-4.0 headers don't have this */
150#define FILE_SHARE_DELETE 0x00000004
151#endif
152
327c3667 153/* access() mode bits */
154#ifndef R_OK
155# define R_OK 4
156# define W_OK 2
157# define X_OK 1
158# define F_OK 0
159#endif
160
cc236deb 161/* for waitpid() */
162#ifndef WNOHANG
163# define WNOHANG 1
164#endif
165
c44d3fdb 166#define PERL_GET_CONTEXT_DEFINED
167
f3986ebb 168/* Compiler-specific stuff. */
169
910dfcc8 170#ifdef __BORLANDC__ /* Borland C++ */
3e3baf6d 171
cb359b41 172#if (__BORLANDC__ <= 0x520)
3e3baf6d 173#define _access access
174#define _chdir chdir
cb359b41 175#endif
176
4ce4f76e 177#define _getpid getpid
26871e0a 178#define wcsicmp _wcsicmp
3e3baf6d 179#include <sys/types.h>
180
84902520 181#ifndef DllMain
182#define DllMain DllEntryPoint
183#endif
184
189b2af5 185#pragma warn -ccc /* "condition is always true/false" */
186#pragma warn -rch /* "unreachable code" */
187#pragma warn -sig /* "conversion may lose significant digits" */
188#pragma warn -pia /* "possibly incorrect assignment" */
189#pragma warn -par /* "parameter 'foo' is never used" */
190#pragma warn -aus /* "'foo' is assigned a value that is never used" */
191#pragma warn -use /* "'foo' is declared but never used" */
192#pragma warn -csu /* "comparing signed and unsigned values" */
3e3baf6d 193
cd183fd9 194/* Borland C thinks that a pointer to a member variable is 12 bytes in size. */
195#define PERL_MEMBER_PTR_SIZE 12
196
1307044d 197#define isnan _isnan
198
910dfcc8 199#endif
3e3baf6d 200
f3986ebb 201#ifdef _MSC_VER /* Microsoft Visual C++ */
202
0a753a76 203typedef long uid_t;
204typedef long gid_t;
a6c40364 205typedef unsigned short mode_t;
c623ac67 206#pragma warning(disable: 4102) /* "unreferenced label" */
f3986ebb 207
0f4eea8f 208/* Visual C thinks that a pointer to a member variable is 16 bytes in size. */
cd183fd9 209#define PERL_MEMBER_PTR_SIZE 16
0f4eea8f 210
5fb4d820 211#define isnan _isnan
212
cab190d4 213#if _MSC_VER < 1300
214/* VC6 has broken NaN semantics: NaN == NaN returns true instead of false */
215#define NAN_COMPARE_BROKEN 1
216#endif
217
f3986ebb 218#endif /* _MSC_VER */
219
910dfcc8 220#ifdef __MINGW32__ /* Minimal Gnu-Win32 */
221
222typedef long uid_t;
223typedef long gid_t;
b1d1613b 224#ifndef _environ
3730b96e 225#define _environ environ
b1d1613b 226#endif
3730b96e 227#define flushall _flushall
228#define fcloseall _fcloseall
6940069f 229#define isnan _isnan /* ...same libraries as MSVC */
910dfcc8 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
8659febc 238/* <stdint.h>, pulled in by <io.h> as of mingw-runtime-3.3, typedef's
239 * (u)intptr_t but doesn't set the _(U)INTPTR_T_DEFINED defines */
240#ifdef _STDINT_H
241# ifndef _INTPTR_T_DEFINED
242# define _INTPTR_T_DEFINED
243# endif
244# ifndef _UINTPTR_T_DEFINED
245# define _UINTPTR_T_DEFINED
246# endif
247#endif
248
910dfcc8 249#endif /* __MINGW32__ */
250
f8fb7c90 251/* both GCC/Mingw32 and MSVC++ 4.0 are missing this, so we put it here */
252#ifndef CP_UTF8
253# define CP_UTF8 65001
254#endif
255
f3986ebb 256/* compatibility stuff for other compilers goes here */
0a753a76 257
c623ac67 258#ifndef _INTPTR_T_DEFINED
259typedef int intptr_t;
260# define _INTPTR_T_DEFINED
261#endif
262
263#ifndef _UINTPTR_T_DEFINED
264typedef unsigned int uintptr_t;
265# define _UINTPTR_T_DEFINED
266#endif
267
390b85e7 268START_EXTERN_C
f3986ebb 269
270/* For UNIX compatibility. */
271
0a753a76 272extern uid_t getuid(void);
273extern gid_t getgid(void);
274extern uid_t geteuid(void);
275extern gid_t getegid(void);
0a753a76 276extern int setuid(uid_t uid);
277extern int setgid(gid_t gid);
278extern int kill(int pid, int sig);
c623ac67 279#ifndef USE_PERL_SBRK
280extern void *sbrk(ptrdiff_t need);
281# define HAS_SBRK_PROTO
282#endif
e34ffe5a 283extern char * getlogin(void);
b990f8c8 284extern int chown(const char *p, uid_t o, gid_t g);
00b02797 285extern int mkstemp(const char *path);
d55594ae 286
f3986ebb 287#undef Stat
288#define Stat win32_stat
3e3baf6d 289
f3986ebb 290#undef init_os_extras
291#define init_os_extras Perl_init_os_extras
390b85e7 292
22239a37 293DllExport void Perl_win32_init(int *argcp, char ***argvp);
23f519f0 294DllExport void Perl_win32_term(void);
cb359b41 295DllExport void Perl_init_os_extras(void);
c5be433b 296DllExport void win32_str_os_error(void *sv, DWORD err);
297DllExport int RunPerl(int argc, char **argv, char **env);
0551aaa8 298
635bbe87 299typedef struct {
300 HANDLE childStdIn;
301 HANDLE childStdOut;
302 HANDLE childStdErr;
f83751a7 303 /*
304 * the following correspond to the fields of the same name
305 * in the STARTUPINFO structure. Embedders can use these to
306 * control the spawning process' look.
307 * Example - to hide the window of the spawned process:
308 * dwFlags = STARTF_USESHOWWINDOW;
309 * wShowWindow = SW_HIDE;
310 */
311 DWORD dwFlags;
3fadfdf1 312 DWORD dwX;
313 DWORD dwY;
314 DWORD dwXSize;
315 DWORD dwYSize;
316 DWORD dwXCountChars;
317 DWORD dwYCountChars;
f83751a7 318 DWORD dwFillAttribute;
3fadfdf1 319 WORD wShowWindow;
635bbe87 320} child_IO_table;
321
322DllExport void win32_get_child_IO(child_IO_table* ptr);
aeecf691 323DllExport HWND win32_create_message_window();
635bbe87 324
f3986ebb 325#ifndef USE_SOCKETS_AS_HANDLES
326extern FILE * my_fdopen(int, char *);
d55594ae 327#endif
f3986ebb 328extern int my_fclose(FILE *);
c623ac67 329extern int my_fstat(int fd, Stat_t *sbufptr);
4ea817c6 330extern char * win32_get_privlib(const char *pl);
331extern char * win32_get_sitelib(const char *pl);
332extern char * win32_get_vendorlib(const char *pl);
f3986ebb 333extern int IsWin95(void);
334extern int IsWinNT(void);
c0932edc 335extern void win32_argv2utf8(int argc, char** argv);
d55594ae 336
1c0ca838 337#ifdef PERL_IMPLICIT_SYS
338extern void win32_delete_internal_host(void *h);
339#endif
340
f3986ebb 341extern char * staticlinkmodules[];
390b85e7 342
343END_EXTERN_C
d55594ae 344
68dc0745 345typedef char * caddr_t; /* In malloc.c (core address). */
0a753a76 346
68dc0745 347/*
68dc0745 348 * handle socket stuff, assuming socket is always available
349 */
0a753a76 350#include <sys/socket.h>
351#include <netdb.h>
352
bbc8f9de 353#ifdef MYMALLOC
354#define EMBEDMYMALLOC /**/
355/* #define USE_PERL_SBRK /**/
356/* #define PERL_SBRK_VIA_MALLOC /**/
357#endif
358
c31fac66 359#if defined(PERLDLL) && !defined(PERL_CORE)
bbc8f9de 360#define PERL_CORE
361#endif
362
e68cb057 363#ifdef PERL_TEXTMODE_SCRIPTS
c39cd008 364# define PERL_SCRIPT_MODE "r"
a868473f 365#else
c39cd008 366# define PERL_SCRIPT_MODE "rb"
a868473f 367#endif
368
3fadfdf1 369/*
370 * Now Win32 specific per-thread data stuff
3352bfcb 371 */
372
aeecf691 373/* Leave the first couple ids after WM_USER unused because they
374 * might be used by an embedding application, and on Windows
375 * version before 2000 we might end up eating those messages
376 * if they were not meant for us.
377 */
378#define WM_USER_MIN (WM_USER+30)
379#define WM_USER_MESSAGE (WM_USER_MIN)
380#define WM_USER_KILL (WM_USER_MIN+1)
381#define WM_USER_MAX (WM_USER_MIN+1)
382
3352bfcb 383struct thread_intern {
384 /* XXX can probably use one buffer instead of several */
385 char Wstrerror_buffer[512];
386 struct servent Wservent;
387 char Wgetlogin_buffer[128];
3352bfcb 388# ifdef HAVE_DES_FCRYPT
389 char Wcrypt_buffer[30];
390# endif
391# ifdef USE_RTL_THREAD_API
392 void * retv; /* slot for thread return value */
393# endif
02637f4c 394 BOOL Wuse_showwindow;
395 WORD Wshowwindow;
3352bfcb 396};
397
4b556e6c 398#define HAVE_INTERP_INTERN
0aaad0ff 399typedef struct {
400 long num;
401 DWORD pids[MAXIMUM_WAIT_OBJECTS];
7766f137 402 HANDLE handles[MAXIMUM_WAIT_OBJECTS];
0aaad0ff 403} child_tab;
404
aeecf691 405#ifdef USE_ITHREADS
406typedef struct {
407 long num;
408 DWORD pids[MAXIMUM_WAIT_OBJECTS];
409 HANDLE handles[MAXIMUM_WAIT_OBJECTS];
410 HWND message_hwnds[MAXIMUM_WAIT_OBJECTS];
411} pseudo_child_tab;
412#endif
413
3fadfdf1 414#ifndef Sighandler_t
415typedef Signal_t (*Sighandler_t) (int);
416#define Sighandler_t Sighandler_t
417#endif
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;
aeecf691 427 pseudo_child_tab * pseudo_children;
7766f137 428#endif
429 void * internal_host;
3352bfcb 430 struct thread_intern thr_intern;
aeecf691 431 HWND message_hwnd;
8fb3fcfb 432 UINT timerid;
05ec9bb3 433 unsigned poll_count;
3fadfdf1 434 Sighandler_t sigtable[SIG_SIZE];
4b556e6c 435};
436
8fb3fcfb 437DllExport int win32_async_check(pTHX);
438
05ec9bb3 439#define WIN32_POLL_INTERVAL 32768
8fb3fcfb 440#define PERL_ASYNC_CHECK() if (w32_do_async || PL_sig_pending) win32_async_check(aTHX)
4b556e6c 441
0aaad0ff 442#define w32_perlshell_tokens (PL_sys_intern.perlshell_tokens)
443#define w32_perlshell_vec (PL_sys_intern.perlshell_vec)
444#define w32_perlshell_items (PL_sys_intern.perlshell_items)
445#define w32_fdpid (PL_sys_intern.fdpid)
446#define w32_children (PL_sys_intern.children)
447#define w32_num_children (w32_children->num)
448#define w32_child_pids (w32_children->pids)
7766f137 449#define w32_child_handles (w32_children->handles)
450#define w32_pseudo_id (PL_sys_intern.pseudo_id)
451#define w32_pseudo_children (PL_sys_intern.pseudo_children)
452#define w32_num_pseudo_children (w32_pseudo_children->num)
453#define w32_pseudo_child_pids (w32_pseudo_children->pids)
454#define w32_pseudo_child_handles (w32_pseudo_children->handles)
aeecf691 455#define w32_pseudo_child_message_hwnds (w32_pseudo_children->message_hwnds)
7766f137 456#define w32_internal_host (PL_sys_intern.internal_host)
8fb3fcfb 457#define w32_timerid (PL_sys_intern.timerid)
aeecf691 458#define w32_message_hwnd (PL_sys_intern.message_hwnd)
3fadfdf1 459#define w32_sighandler (PL_sys_intern.sigtable)
05ec9bb3 460#define w32_poll_count (PL_sys_intern.poll_count)
461#define w32_do_async (w32_poll_count++ > WIN32_POLL_INTERVAL)
3db8f154 462#define w32_strerror_buffer (PL_sys_intern.thr_intern.Wstrerror_buffer)
463#define w32_getlogin_buffer (PL_sys_intern.thr_intern.Wgetlogin_buffer)
464#define w32_crypt_buffer (PL_sys_intern.thr_intern.Wcrypt_buffer)
465#define w32_servent (PL_sys_intern.thr_intern.Wservent)
3db8f154 466#define w32_use_showwindow (PL_sys_intern.thr_intern.Wuse_showwindow)
467#define w32_showwindow (PL_sys_intern.thr_intern.Wshowwindow)
c53bd28a 468
7766f137 469#ifdef USE_ITHREADS
470# define PERL_WAIT_FOR_CHILDREN \
471 STMT_START { \
472 if (w32_pseudo_children && w32_num_pseudo_children) { \
473 long children = w32_num_pseudo_children; \
474 WaitForMultipleObjects(children, \
475 w32_pseudo_child_handles, \
476 TRUE, INFINITE); \
477 while (children) \
478 CloseHandle(w32_pseudo_child_handles[--children]); \
479 } \
480 } STMT_END
481#endif
482
a10b7b7e 483#if defined(USE_FIXED_OSFHANDLE) || defined(PERL_MSVCRT_READFIX)
484#ifdef PERL_CORE
485
486/* C doesn't like repeat struct definitions */
df500c58 487#if defined(__MINGW32__) && (__MINGW32_MAJOR_VERSION>=3)
15689010 488#undef _CRTIMP
489#endif
a10b7b7e 490#ifndef _CRTIMP
491#define _CRTIMP __declspec(dllimport)
492#endif
493
494/*
495 * Control structure for lowio file handles
496 */
497typedef struct {
c623ac67 498 intptr_t osfhnd;/* underlying OS file HANDLE */
a10b7b7e 499 char osfile; /* attributes of file (e.g., open in text mode?) */
500 char pipech; /* one char buffer for handles opened on pipes */
501 int lockinitflag;
502 CRITICAL_SECTION lock;
503} ioinfo;
504
505
506/*
507 * Array of arrays of control structures for lowio files.
508 */
509EXTERN_C _CRTIMP ioinfo* __pioinfo[];
510
511/*
512 * Definition of IOINFO_L2E, the log base 2 of the number of elements in each
513 * array of ioinfo structs.
514 */
515#define IOINFO_L2E 5
516
517/*
518 * Definition of IOINFO_ARRAY_ELTS, the number of elements in ioinfo array
519 */
520#define IOINFO_ARRAY_ELTS (1 << IOINFO_L2E)
521
522/*
523 * Access macros for getting at an ioinfo struct and its fields from a
524 * file handle
525 */
526#define _pioinfo(i) (__pioinfo[(i) >> IOINFO_L2E] + ((i) & (IOINFO_ARRAY_ELTS - 1)))
527#define _osfhnd(i) (_pioinfo(i)->osfhnd)
528#define _osfile(i) (_pioinfo(i)->osfile)
529#define _pipech(i) (_pioinfo(i)->pipech)
530
531/* since we are not doing a dup2(), this works fine */
c623ac67 532#define _set_osfhnd(fh, osfh) (void)(_osfhnd(fh) = (intptr_t)osfh)
a10b7b7e 533#endif
534#endif
535
3fadfdf1 536/* IO.xs and POSIX.xs define PERLIO_NOT_STDIO to 1 */
6e22d046 537#if defined(PERL_EXT_IO) || defined(PERL_EXT_POSIX)
538#undef PERLIO_NOT_STDIO
539#endif
adb71456 540#define PERLIO_NOT_STDIO 0
541
542#include "perlio.h"
543
4f63d024 544/*
545 * This provides a layer of functions and macros to ensure extensions will
546 * get to use the same RTL functions as the core.
547 */
548#include "win32iop.h"
549
b4748376 550#define EXEC_ARGV_CAST(x) ((const char *const *) x)
551
4fb841ef 552#if !defined(ECONNABORTED) && defined(WSAECONNABORTED)
553#define ECONNABORTED WSAECONNABORTED
554#endif
f2b62286 555#if !defined(ECONNRESET) && defined(WSAECONNRESET)
556#define ECONNRESET WSAECONNRESET
557#endif
4fb841ef 558#if !defined(EAFNOSUPPORT) && defined(WSAEAFNOSUPPORT)
559#define EAFNOSUPPORT WSAEAFNOSUPPORT
560#endif
f2b62286 561/* Why not needed for ECONNREFUSED? --abe */
4fb841ef 562
f4958739 563DllExport void *win32_signal_context(void);
1018e26f 564#define PERL_GET_SIG_CONTEXT win32_signal_context()
565
68dc0745 566#endif /* _INC_WIN32_PERL5 */
7a9ec5a3 567