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