This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
accept() leaks memory on windows due to incorrect ordering of
[perl5.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
GS
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
DL
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
DL
29#endif
30
a835ef8a 31#ifdef __GNUC__
b7c82df9
GS
32# ifndef __int64 /* some versions seem to #define it already */
33# define __int64 long long
34# endif
db15561c 35# define Win32_Winsock
a835ef8a
NIS
36#endif
37
22239a37
NIS
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
GS
44/* now even GCC supports __declspec() */
45
c69f6586
GS
46#if defined(PERL_OBJECT)
47#define DllExport
48#else
22239a37 49#if defined(PERLDLL) || defined(WIN95FIX)
852c2e52
GS
50#define DllExport
51/*#define DllExport __declspec(dllexport)*/ /* noises with VC5+sp3 */
22239a37
NIS
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
GS
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
GS
75#ifndef EXT
76#include "EXTERN.h"
77#endif
78
c69f112c
NIS
79struct tms {
80 long tms_utime;
81 long tms_stime;
82 long tms_cutime;
83 long tms_cstime;
84};
85
b2af26b1
GS
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
GS
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
GS
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
GS
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
f3986ebb
GS
125/* if USE_WIN32_RTL_ENV is not defined, Perl uses direct Win32 calls
126 * to read the environment, bypassing the runtime's (usually broken)
127 * facilities for accessing the same. See note in util.c/my_setenv(). */
128/*#define USE_WIN32_RTL_ENV */
0a753a76 129
9e5f57de
GS
130/* Define USE_FIXED_OSFHANDLE to fix MSVCRT's _open_osfhandle() on W95.
131 It now uses some black magic to work seamlessly with the DLL CRT and
132 works with MSVC++ 4.0+ or GCC/Mingw32
133 -- BKS 1-24-2000 */
134#if (defined(_M_IX86) && _MSC_VER >= 1000) || defined(__MINGW32__)
f3986ebb
GS
135#define USE_FIXED_OSFHANDLE
136#endif
137
902173a3
GS
138#define ENV_IS_CASELESS
139
d41de25a 140#ifndef VER_PLATFORM_WIN32_WINDOWS /* VC-2.0 headers don't have this */
f3986ebb
GS
141#define VER_PLATFORM_WIN32_WINDOWS 1
142#endif
143
d41de25a
GS
144#ifndef FILE_SHARE_DELETE /* VC-4.0 headers don't have this */
145#define FILE_SHARE_DELETE 0x00000004
146#endif
147
327c3667
GS
148/* access() mode bits */
149#ifndef R_OK
150# define R_OK 4
151# define W_OK 2
152# define X_OK 1
153# define F_OK 0
154#endif
155
c44d3fdb
GS
156#define PERL_GET_CONTEXT_DEFINED
157
f3986ebb
GS
158/* Compiler-specific stuff. */
159
910dfcc8 160#ifdef __BORLANDC__ /* Borland C++ */
3e3baf6d
TB
161
162#define _access access
163#define _chdir chdir
4ce4f76e 164#define _getpid getpid
26871e0a 165#define wcsicmp _wcsicmp
3e3baf6d
TB
166#include <sys/types.h>
167
84902520
TB
168#ifndef DllMain
169#define DllMain DllEntryPoint
170#endif
171
189b2af5
GS
172#pragma warn -ccc /* "condition is always true/false" */
173#pragma warn -rch /* "unreachable code" */
174#pragma warn -sig /* "conversion may lose significant digits" */
175#pragma warn -pia /* "possibly incorrect assignment" */
176#pragma warn -par /* "parameter 'foo' is never used" */
177#pragma warn -aus /* "'foo' is assigned a value that is never used" */
178#pragma warn -use /* "'foo' is declared but never used" */
179#pragma warn -csu /* "comparing signed and unsigned values" */
180#pragma warn -pro /* "call to function with no prototype" */
327c3667 181#pragma warn -stu /* "undefined structure 'foo'" */
3e3baf6d 182
ac4c12e7
GS
183/* Borland is picky about a bare member function name used as its ptr */
184#ifdef PERL_OBJECT
0b94c7bb 185# define MEMBER_TO_FPTR(name) &(name)
ac4c12e7
GS
186#endif
187
cd183fd9
GS
188/* Borland C thinks that a pointer to a member variable is 12 bytes in size. */
189#define PERL_MEMBER_PTR_SIZE 12
190
910dfcc8 191#endif
3e3baf6d 192
f3986ebb
GS
193#ifdef _MSC_VER /* Microsoft Visual C++ */
194
0a753a76 195typedef long uid_t;
196typedef long gid_t;
a6c40364 197typedef unsigned short mode_t;
f3986ebb
GS
198#pragma warning(disable: 4018 4035 4101 4102 4244 4245 4761)
199
0f4eea8f 200/* Visual C thinks that a pointer to a member variable is 16 bytes in size. */
cd183fd9 201#define PERL_MEMBER_PTR_SIZE 16
0f4eea8f 202
5fb4d820
GS
203#define isnan _isnan
204
f3986ebb
GS
205#endif /* _MSC_VER */
206
910dfcc8
GS
207#ifdef __MINGW32__ /* Minimal Gnu-Win32 */
208
209typedef long uid_t;
210typedef long gid_t;
b1d1613b 211#ifndef _environ
3730b96e 212#define _environ environ
b1d1613b 213#endif
3730b96e
GS
214#define flushall _flushall
215#define fcloseall _fcloseall
910dfcc8 216
db15561c 217#ifdef PERL_OBJECT
0b94c7bb 218# define MEMBER_TO_FPTR(name) &(name)
db15561c
GS
219#endif
220
ac4c12e7
GS
221#ifndef _O_NOINHERIT
222# define _O_NOINHERIT 0x0080
223# ifndef _NO_OLDNAMES
224# define O_NOINHERIT _O_NOINHERIT
225# endif
226#endif
227
910dfcc8
GS
228#endif /* __MINGW32__ */
229
f8fb7c90
GS
230/* both GCC/Mingw32 and MSVC++ 4.0 are missing this, so we put it here */
231#ifndef CP_UTF8
232# define CP_UTF8 65001
233#endif
234
f3986ebb 235/* compatibility stuff for other compilers goes here */
0a753a76 236
0a753a76 237
dfdd1393 238#if !defined(PERL_OBJECT) && defined(PERL_CAPI) && defined(PERL_MEMBER_PTR_SIZE)
cd183fd9
GS
239# define STRUCT_MGVTBL_DEFINITION \
240struct mgvtbl { \
241 union { \
242 int (CPERLscope(*svt_get))(pTHX_ SV *sv, MAGIC* mg); \
243 char handle_VC_problem1[PERL_MEMBER_PTR_SIZE]; \
244 }; \
245 union { \
246 int (CPERLscope(*svt_set))(pTHX_ SV *sv, MAGIC* mg); \
247 char handle_VC_problem2[PERL_MEMBER_PTR_SIZE]; \
248 }; \
249 union { \
250 U32 (CPERLscope(*svt_len))(pTHX_ SV *sv, MAGIC* mg); \
251 char handle_VC_problem3[PERL_MEMBER_PTR_SIZE]; \
252 }; \
253 union { \
254 int (CPERLscope(*svt_clear))(pTHX_ SV *sv, MAGIC* mg); \
255 char handle_VC_problem4[PERL_MEMBER_PTR_SIZE]; \
256 }; \
257 union { \
258 int (CPERLscope(*svt_free))(pTHX_ SV *sv, MAGIC* mg); \
259 char handle_VC_problem5[PERL_MEMBER_PTR_SIZE]; \
260 }; \
261}
262
263# define BASEOP_DEFINITION \
264 OP* op_next; \
265 OP* op_sibling; \
266 OP* (CPERLscope(*op_ppaddr))(pTHX); \
267 char handle_VC_problem[PERL_MEMBER_PTR_SIZE-sizeof(OP*)]; \
268 PADOFFSET op_targ; \
269 OPCODE op_type; \
270 U16 op_seq; \
271 U8 op_flags; \
272 U8 op_private;
273
dfdd1393 274#endif /* !PERL_OBJECT && PERL_CAPI && PERL_MEMBER_PTR_SIZE */
cd183fd9
GS
275
276
390b85e7 277START_EXTERN_C
f3986ebb
GS
278
279/* For UNIX compatibility. */
280
0a753a76 281extern uid_t getuid(void);
282extern gid_t getgid(void);
283extern uid_t geteuid(void);
284extern gid_t getegid(void);
0a753a76 285extern int setuid(uid_t uid);
286extern int setgid(gid_t gid);
287extern int kill(int pid, int sig);
161b471a 288extern void *sbrk(int need);
e34ffe5a 289extern char * getlogin(void);
b990f8c8 290extern int chown(const char *p, uid_t o, gid_t g);
d55594ae 291
f3986ebb
GS
292#undef Stat
293#define Stat win32_stat
3e3baf6d 294
f3986ebb
GS
295#undef init_os_extras
296#define init_os_extras Perl_init_os_extras
390b85e7 297
22239a37 298DllExport void Perl_win32_init(int *argcp, char ***argvp);
c5be433b
GS
299DllExport void Perl_init_os_extras();
300DllExport void win32_str_os_error(void *sv, DWORD err);
301DllExport int RunPerl(int argc, char **argv, char **env);
0551aaa8 302
635bbe87
GS
303typedef struct {
304 HANDLE childStdIn;
305 HANDLE childStdOut;
306 HANDLE childStdErr;
f83751a7
GS
307 /*
308 * the following correspond to the fields of the same name
309 * in the STARTUPINFO structure. Embedders can use these to
310 * control the spawning process' look.
311 * Example - to hide the window of the spawned process:
312 * dwFlags = STARTF_USESHOWWINDOW;
313 * wShowWindow = SW_HIDE;
314 */
315 DWORD dwFlags;
316 DWORD dwX;
317 DWORD dwY;
318 DWORD dwXSize;
319 DWORD dwYSize;
320 DWORD dwXCountChars;
321 DWORD dwYCountChars;
322 DWORD dwFillAttribute;
323 WORD wShowWindow;
635bbe87
GS
324} child_IO_table;
325
326DllExport void win32_get_child_IO(child_IO_table* ptr);
327
f3986ebb
GS
328#ifndef USE_SOCKETS_AS_HANDLES
329extern FILE * my_fdopen(int, char *);
d55594ae 330#endif
f3986ebb 331extern int my_fclose(FILE *);
c5be433b
GS
332extern int do_aspawn(void *really, void **mark, void **sp);
333extern int do_spawn(char *cmd);
334extern int do_spawn_nowait(char *cmd);
4ea817c6
GS
335extern char * win32_get_privlib(const char *pl);
336extern char * win32_get_sitelib(const char *pl);
337extern char * win32_get_vendorlib(const char *pl);
f3986ebb
GS
338extern int IsWin95(void);
339extern int IsWinNT(void);
c0932edc 340extern void win32_argv2utf8(int argc, char** argv);
d55594ae 341
1c0ca838
GS
342#ifdef PERL_IMPLICIT_SYS
343extern void win32_delete_internal_host(void *h);
344#endif
345
f3986ebb 346extern char * staticlinkmodules[];
390b85e7
GS
347
348END_EXTERN_C
d55594ae 349
68dc0745 350typedef char * caddr_t; /* In malloc.c (core address). */
0a753a76 351
68dc0745 352/*
68dc0745 353 * handle socket stuff, assuming socket is always available
354 */
0a753a76 355#include <sys/socket.h>
356#include <netdb.h>
357
bbc8f9de
NIS
358#ifdef MYMALLOC
359#define EMBEDMYMALLOC /**/
360/* #define USE_PERL_SBRK /**/
361/* #define PERL_SBRK_VIA_MALLOC /**/
362#endif
363
c31fac66 364#if defined(PERLDLL) && !defined(PERL_CORE)
bbc8f9de
NIS
365#define PERL_CORE
366#endif
367
e68cb057 368#ifdef PERL_TEXTMODE_SCRIPTS
c39cd008 369# define PERL_SCRIPT_MODE "r"
a868473f 370#else
c39cd008 371# define PERL_SCRIPT_MODE "rb"
a868473f
NIS
372#endif
373
3352bfcb
GS
374/*
375 * Now Win32 specific per-thread data stuff
376 */
377
378struct thread_intern {
379 /* XXX can probably use one buffer instead of several */
380 char Wstrerror_buffer[512];
381 struct servent Wservent;
382 char Wgetlogin_buffer[128];
383# ifdef USE_SOCKETS_AS_HANDLES
384 int Winit_socktype;
385# endif
386# ifdef HAVE_DES_FCRYPT
387 char Wcrypt_buffer[30];
388# endif
389# ifdef USE_RTL_THREAD_API
390 void * retv; /* slot for thread return value */
391# endif
392};
393
394#ifdef USE_THREADS
395# ifndef USE_DECLSPEC_THREAD
396# define HAVE_THREAD_INTERN
397# endif /* !USE_DECLSPEC_THREAD */
398#endif /* USE_THREADS */
399
4b556e6c 400#define HAVE_INTERP_INTERN
0aaad0ff
GS
401typedef struct {
402 long num;
403 DWORD pids[MAXIMUM_WAIT_OBJECTS];
7766f137 404 HANDLE handles[MAXIMUM_WAIT_OBJECTS];
0aaad0ff
GS
405} child_tab;
406
4b556e6c 407struct interp_intern {
0aaad0ff
GS
408 char * perlshell_tokens;
409 char ** perlshell_vec;
410 long perlshell_items;
411 struct av * fdpid;
412 child_tab * children;
7766f137
GS
413#ifdef USE_ITHREADS
414 DWORD pseudo_id;
415 child_tab * pseudo_children;
416#endif
417 void * internal_host;
3352bfcb
GS
418#ifndef USE_THREADS
419 struct thread_intern thr_intern;
420#endif
4b556e6c
JD
421};
422
4b556e6c 423
0aaad0ff
GS
424#define w32_perlshell_tokens (PL_sys_intern.perlshell_tokens)
425#define w32_perlshell_vec (PL_sys_intern.perlshell_vec)
426#define w32_perlshell_items (PL_sys_intern.perlshell_items)
427#define w32_fdpid (PL_sys_intern.fdpid)
428#define w32_children (PL_sys_intern.children)
429#define w32_num_children (w32_children->num)
430#define w32_child_pids (w32_children->pids)
7766f137
GS
431#define w32_child_handles (w32_children->handles)
432#define w32_pseudo_id (PL_sys_intern.pseudo_id)
433#define w32_pseudo_children (PL_sys_intern.pseudo_children)
434#define w32_num_pseudo_children (w32_pseudo_children->num)
435#define w32_pseudo_child_pids (w32_pseudo_children->pids)
436#define w32_pseudo_child_handles (w32_pseudo_children->handles)
437#define w32_internal_host (PL_sys_intern.internal_host)
c53bd28a 438#ifdef USE_THREADS
3352bfcb
GS
439# define w32_strerror_buffer (thr->i.Wstrerror_buffer)
440# define w32_getlogin_buffer (thr->i.Wgetlogin_buffer)
441# define w32_crypt_buffer (thr->i.Wcrypt_buffer)
442# define w32_servent (thr->i.Wservent)
443# define w32_init_socktype (thr->i.Winit_socktype)
444#else
445# define w32_strerror_buffer (PL_sys_intern.thr_intern.Wstrerror_buffer)
446# define w32_getlogin_buffer (PL_sys_intern.thr_intern.Wgetlogin_buffer)
447# define w32_crypt_buffer (PL_sys_intern.thr_intern.Wcrypt_buffer)
448# define w32_servent (PL_sys_intern.thr_intern.Wservent)
449# define w32_init_socktype (PL_sys_intern.thr_intern.Winit_socktype)
e34ffe5a 450#endif /* USE_THREADS */
c53bd28a 451
7fac1903
GS
452/* UNICODE<>ANSI translation helpers */
453/* Use CP_ACP when mode is ANSI */
454/* Use CP_UTF8 when mode is UTF8 */
455
e9ff6d27
GS
456#define A2WHELPER_LEN(lpa, alen, lpw, nBytes)\
457 (lpw[0] = 0, MultiByteToWideChar((IN_BYTE) ? CP_ACP : CP_UTF8, 0, \
458 lpa, alen, lpw, (nBytes/sizeof(WCHAR))))
459#define A2WHELPER(lpa, lpw, nBytes) A2WHELPER_LEN(lpa, -1, lpw, nBytes)
460
461#define W2AHELPER_LEN(lpw, wlen, lpa, nChars)\
462 (lpa[0] = '\0', WideCharToMultiByte((IN_BYTE) ? CP_ACP : CP_UTF8, 0, \
463 lpw, wlen, (LPSTR)lpa, nChars,NULL,NULL))
464#define W2AHELPER(lpw, lpa, nChars) W2AHELPER_LEN(lpw, -1, lpa, nChars)
7fac1903 465
46487f74 466#define USING_WIDE() (PL_widesyscalls && PerlEnv_os_id() == VER_PLATFORM_WIN32_NT)
7fac1903 467
7766f137
GS
468#ifdef USE_ITHREADS
469# define PERL_WAIT_FOR_CHILDREN \
470 STMT_START { \
471 if (w32_pseudo_children && w32_num_pseudo_children) { \
472 long children = w32_num_pseudo_children; \
473 WaitForMultipleObjects(children, \
474 w32_pseudo_child_handles, \
475 TRUE, INFINITE); \
476 while (children) \
477 CloseHandle(w32_pseudo_child_handles[--children]); \
478 } \
479 } STMT_END
480#endif
481
4f63d024
GS
482/*
483 * This provides a layer of functions and macros to ensure extensions will
484 * get to use the same RTL functions as the core.
485 */
486#include "win32iop.h"
487
68dc0745 488#endif /* _INC_WIN32_PERL5 */
7a9ec5a3 489