This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
2c821eb24eb88e5309f08bf756d11da1488c1d7e
[perl5.git] / win32 / win32.h
1 /* WIN32.H
2  *
3  * (c) 1995 Microsoft Corporation. All rights reserved.
4  *              Developed by hip communications inc.
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  */
9 #ifndef  _INC_WIN32_PERL5
10 #define  _INC_WIN32_PERL5
11
12 #ifndef _WIN32_WINNT
13 #  define _WIN32_WINNT 0x0500     /* needed for CreateHardlink() etc. */
14 #endif
15
16 #if defined(PERL_IMPLICIT_SYS)
17 #  define DYNAMIC_ENV_FETCH
18 #  define HAS_GETENV_LEN
19 #  define prime_env_iter()
20 #  define WIN32IO_IS_STDIO              /* don't pull in custom stdio layer */
21 #  define WIN32SCK_IS_STDSCK            /* don't pull in custom wsock layer */
22 #  ifdef PERL_GLOBAL_STRUCT
23 #    error PERL_GLOBAL_STRUCT cannot be defined with PERL_IMPLICIT_SYS
24 #  endif
25 #  define win32_get_privlib PerlEnv_lib_path
26 #  define win32_get_sitelib PerlEnv_sitelib_path
27 #  define win32_get_vendorlib PerlEnv_vendorlib_path
28 #endif
29
30 #ifdef __GNUC__
31 #  ifndef __int64               /* some versions seem to #define it already */
32 #    define __int64 long long
33 #  endif
34 #  define Win32_Winsock
35 #ifdef __cplusplus
36 /* Mingw32 gcc -xc++ objects to __attribute((unused)) at least */
37 #undef  PERL_UNUSED_DECL
38 #define PERL_UNUSED_DECL
39 #endif
40 #endif
41
42
43 /* Define DllExport akin to perl's EXT,
44  * If we are in the DLL then Export the symbol,
45  * otherwise import it.
46  */
47
48 /* now even GCC supports __declspec() */
49
50 #if defined(PERLDLL)
51 #define DllExport
52 /*#define DllExport __declspec(dllexport)*/     /* noises with VC5+sp3 */
53 #else
54 #define DllExport __declspec(dllimport)
55 #endif
56
57 /* The Perl APIs can only be called directly inside the perl5xx.dll.
58  * All other code has to import them.  By declaring them as "dllimport"
59  * we tell the compiler to generate an indirect call instruction and
60  * avoid redirection through a call thunk.
61  *
62  * The XS code in the re extension is special, in that it redefines
63  * core APIs locally, so don't mark them as "dllimport" because GCC
64  * cannot handle this situation.
65  */
66 #if !defined(PERLDLL) && !defined(PERL_EXT_RE_BUILD)
67 #  ifdef __cplusplus
68 #    define PERL_CALLCONV extern "C" __declspec(dllimport)
69 #    ifdef _MSC_VER
70 #      define PERL_CALLCONV_NO_RET extern "C" __declspec(dllimport, noreturn)
71 #    endif
72 #  else
73 #    define PERL_CALLCONV __declspec(dllimport)
74 #    ifdef _MSC_VER
75 #      define PERL_CALLCONV_NO_RET __declspec(dllimport, noreturn)
76 #    endif
77 #  endif
78 #endif
79
80 #define  WIN32_LEAN_AND_MEAN
81 #include <windows.h>
82
83 /*
84  * Bug in winbase.h in mingw-w64 4.4.0-1 at least... they
85  * do #define GetEnvironmentStringsA GetEnvironmentStrings and fail
86  * to declare GetEnvironmentStringsA.
87  */
88 #if defined(__MINGW64__) && defined(GetEnvironmentStringsA) && !defined(UNICODE)
89 #ifdef __cplusplus
90 extern "C" {
91 #endif
92 #undef GetEnvironmentStringsA
93 WINBASEAPI LPCH WINAPI GetEnvironmentStringsA(VOID);
94 #define GetEnvironmentStrings GetEnvironmentStringsA
95 #ifdef __cplusplus
96 }
97 #endif
98 #endif
99
100 #ifdef   WIN32_LEAN_AND_MEAN            /* C file is NOT a Perl5 original. */
101 #define  CONTEXT        PERL_CONTEXT    /* Avoid conflict of CONTEXT defs. */
102 #endif /*WIN32_LEAN_AND_MEAN */
103
104 #ifndef TLS_OUT_OF_INDEXES
105 #define TLS_OUT_OF_INDEXES (DWORD)0xFFFFFFFF
106 #endif
107
108 #include <dirent.h>
109 #include <io.h>
110 #include <process.h>
111 #include <stdio.h>
112 #include <direct.h>
113 #include <stdlib.h>
114 #include <stddef.h>
115 #include <fcntl.h>
116 #ifndef EXT
117 #include "EXTERN.h"
118 #endif
119
120 struct tms {
121         long    tms_utime;
122         long    tms_stime;
123         long    tms_cutime;
124         long    tms_cstime;
125 };
126
127 #ifndef SYS_NMLN
128 #define SYS_NMLN        257
129 #endif
130
131 struct utsname {
132     char sysname[SYS_NMLN];
133     char nodename[SYS_NMLN];
134     char release[SYS_NMLN];
135     char version[SYS_NMLN];
136     char machine[SYS_NMLN];
137 };
138
139 #ifndef START_EXTERN_C
140 #undef EXTERN_C
141 #ifdef __cplusplus
142 #  define START_EXTERN_C extern "C" {
143 #  define END_EXTERN_C }
144 #  define EXTERN_C extern "C"
145 #else
146 #  define START_EXTERN_C
147 #  define END_EXTERN_C
148 #  define EXTERN_C
149 #endif
150 #endif
151
152 #define  STANDARD_C     1
153 #define  DOSISH         1               /* no escaping our roots */
154 #define  OP_BINARY      O_BINARY        /* mistake in in pp_sys.c? */
155
156 /* Define USE_SOCKETS_AS_HANDLES to enable emulation of windows sockets as
157  * real filehandles. XXX Should always be defined (the other version is untested) */
158 #define USE_SOCKETS_AS_HANDLES
159
160 /* read() and write() aren't transparent for socket handles */
161 #define PERL_SOCK_SYSREAD_IS_RECV
162 #define PERL_SOCK_SYSWRITE_IS_SEND
163
164 #define PERL_NO_FORCE_LINK              /* no need for PL_force_link_funcs */
165
166 /* Define PERL_WIN32_SOCK_DLOAD to have Perl dynamically load the winsock
167    DLL when needed. Don't use if your compiler supports delayloading (ie, VC++ 6.0)
168         -- BKS 5-29-2000 */
169 #if !(defined(_M_IX86) && _MSC_VER >= 1200)
170 #define PERL_WIN32_SOCK_DLOAD
171 #endif
172 #define ENV_IS_CASELESS
173
174 #define PIPESOCK_MODE   "b"             /* pipes, sockets default to binmode */
175
176 #ifndef VER_PLATFORM_WIN32_WINDOWS      /* VC-2.0 headers don't have this */
177 #define VER_PLATFORM_WIN32_WINDOWS      1
178 #endif
179
180 #ifndef FILE_SHARE_DELETE               /* VC-4.0 headers don't have this */
181 #define FILE_SHARE_DELETE               0x00000004
182 #endif
183
184 /* access() mode bits */
185 #ifndef R_OK
186 #  define       R_OK    4
187 #  define       W_OK    2
188 #  define       X_OK    1
189 #  define       F_OK    0
190 #endif
191
192 /* for waitpid() */
193 #ifndef WNOHANG
194 #  define WNOHANG       1
195 #endif
196
197 #define PERL_GET_CONTEXT_DEFINED
198
199 /* Compiler-specific stuff. */
200
201 #if defined(_MSC_VER) || defined(__MINGW32__)
202 /* VC uses non-standard way to determine the size and alignment if bit-fields */
203 /* MinGW will compiler with -mms-bitfields, so should use the same types */
204 #  define PERL_BITFIELD8  unsigned char
205 #  define PERL_BITFIELD16 unsigned short
206 #  define PERL_BITFIELD32 unsigned int
207 #endif
208
209 #ifdef _MSC_VER                 /* Microsoft Visual C++ */
210
211 #ifndef UNDER_CE
212 typedef long            uid_t;
213 typedef long            gid_t;
214 typedef unsigned short  mode_t;
215 #endif
216
217 #pragma  warning(disable: 4102) /* "unreferenced label" */
218
219 /* Visual C thinks that a pointer to a member variable is 16 bytes in size. */
220 #define PERL_MEMBER_PTR_SIZE    16
221
222 #define isnan           _isnan
223 #define snprintf        _snprintf
224 #define vsnprintf       _vsnprintf
225
226 #if _MSC_VER < 1300
227 /* VC6 has broken NaN semantics: NaN == NaN returns true instead of false */
228 #define NAN_COMPARE_BROKEN 1
229 #endif
230
231 #endif /* _MSC_VER */
232
233 #ifdef __MINGW32__              /* Minimal Gnu-Win32 */
234
235 typedef long            uid_t;
236 typedef long            gid_t;
237 #ifndef _environ
238 #define _environ        environ
239 #endif
240 #define flushall        _flushall
241 #define fcloseall       _fcloseall
242 #ifndef isnan
243 #define isnan           _isnan  /* ...same libraries as MSVC */
244 #endif
245
246 #ifndef _O_NOINHERIT
247 #  define _O_NOINHERIT  0x0080
248 #  ifndef _NO_OLDNAMES
249 #    define O_NOINHERIT _O_NOINHERIT
250 #  endif
251 #endif
252
253 /* <stdint.h>, pulled in by <io.h> as of mingw-runtime-3.3, typedef's
254  * (u)intptr_t but doesn't set the _(U)INTPTR_T_DEFINED defines */
255 #ifdef _STDINT_H
256 #  ifndef _INTPTR_T_DEFINED
257 #    define _INTPTR_T_DEFINED
258 #  endif
259 #  ifndef _UINTPTR_T_DEFINED
260 #    define _UINTPTR_T_DEFINED
261 #  endif
262 #endif
263
264 #endif /* __MINGW32__ */
265
266 /* both GCC/Mingw32 and MSVC++ 4.0 are missing this, so we put it here */
267 #ifndef CP_UTF8
268 #  define CP_UTF8       65001
269 #endif
270
271 /* compatibility stuff for other compilers goes here */
272
273 #ifndef _INTPTR_T_DEFINED
274 typedef int             intptr_t;
275 #  define _INTPTR_T_DEFINED
276 #endif
277
278 #ifndef _UINTPTR_T_DEFINED
279 typedef unsigned int    uintptr_t;
280 #  define _UINTPTR_T_DEFINED
281 #endif
282
283 START_EXTERN_C
284
285 /* For UNIX compatibility. */
286
287 extern  uid_t   getuid(void);
288 extern  gid_t   getgid(void);
289 extern  uid_t   geteuid(void);
290 extern  gid_t   getegid(void);
291 extern  int     setuid(uid_t uid);
292 extern  int     setgid(gid_t gid);
293 extern  int     kill(int pid, int sig);
294 extern  int     killpg(int pid, int sig);
295 #ifndef USE_PERL_SBRK
296 extern  void    *sbrk(ptrdiff_t need);
297 #  define HAS_SBRK_PROTO
298 #endif
299 extern  char *  getlogin(void);
300 extern  int     chown(const char *p, uid_t o, gid_t g);
301 extern  int     mkstemp(const char *path);
302
303 #undef   Stat
304 #define  Stat           win32_stat
305
306 #undef   init_os_extras
307 #define  init_os_extras Perl_init_os_extras
308
309 DllExport void          Perl_win32_init(int *argcp, char ***argvp);
310 DllExport void          Perl_win32_term(void);
311 DllExport void          Perl_init_os_extras(void);
312 DllExport void          win32_str_os_error(void *sv, DWORD err);
313 DllExport int           RunPerl(int argc, char **argv, char **env);
314
315 typedef struct {
316     HANDLE      childStdIn;
317     HANDLE      childStdOut;
318     HANDLE      childStdErr;
319     /*
320      * the following correspond to the fields of the same name
321      * in the STARTUPINFO structure. Embedders can use these to
322      * control the spawning process' look.
323      * Example - to hide the window of the spawned process:
324      *    dwFlags = STARTF_USESHOWWINDOW;
325      *    wShowWindow = SW_HIDE;
326      */
327     DWORD       dwFlags;
328     DWORD       dwX;
329     DWORD       dwY;
330     DWORD       dwXSize;
331     DWORD       dwYSize;
332     DWORD       dwXCountChars;
333     DWORD       dwYCountChars;
334     DWORD       dwFillAttribute;
335     WORD        wShowWindow;
336 } child_IO_table;
337
338 DllExport void          win32_get_child_IO(child_IO_table* ptr);
339 DllExport HWND          win32_create_message_window(void);
340
341 #ifndef USE_SOCKETS_AS_HANDLES
342 extern FILE *           my_fdopen(int, char *);
343 #endif
344 extern int              my_fclose(FILE *);
345 extern char *           win32_get_privlib(const char *pl, STRLEN *const len);
346 extern char *           win32_get_sitelib(const char *pl, STRLEN *const len);
347 extern char *           win32_get_vendorlib(const char *pl, STRLEN *const len);
348
349 #ifdef PERL_IMPLICIT_SYS
350 extern void             win32_delete_internal_host(void *h);
351 #endif
352
353 extern char *           staticlinkmodules[];
354
355 END_EXTERN_C
356
357 typedef  char *         caddr_t;        /* In malloc.c (core address). */
358
359 /*
360  * handle socket stuff, assuming socket is always available
361  */
362 #include <sys/socket.h>
363 #include <netdb.h>
364
365 #ifdef MYMALLOC
366 #define EMBEDMYMALLOC   /**/
367 /* #define USE_PERL_SBRK        /**/
368 /* #define PERL_SBRK_VIA_MALLOC /**/
369 #endif
370
371 #ifdef PERL_TEXTMODE_SCRIPTS
372 #  define PERL_SCRIPT_MODE              "r"
373 #else
374 #  define PERL_SCRIPT_MODE              "rb"
375 #endif
376
377 /*
378  * Now Win32 specific per-thread data stuff
379  */
380
381 /* Leave the first couple ids after WM_USER unused because they
382  * might be used by an embedding application, and on Windows
383  * version before 2000 we might end up eating those messages
384  * if they were not meant for us.
385  */
386 #define WM_USER_MIN     (WM_USER+30)
387 #define WM_USER_MESSAGE (WM_USER_MIN)
388 #define WM_USER_KILL    (WM_USER_MIN+1)
389 #define WM_USER_MAX     (WM_USER_MIN+1)
390
391 struct thread_intern {
392     /* XXX can probably use one buffer instead of several */
393     char                Wstrerror_buffer[512];
394     struct servent      Wservent;
395     char                Wgetlogin_buffer[128];
396 #    ifdef USE_SOCKETS_AS_HANDLES
397     int                 Winit_socktype;
398 #    endif
399     char                Wcrypt_buffer[30];
400 #    ifdef USE_RTL_THREAD_API
401     void *              retv;   /* slot for thread return value */
402 #    endif
403     BOOL               Wuse_showwindow;
404     WORD               Wshowwindow;
405 };
406
407 #define HAVE_INTERP_INTERN
408 typedef struct {
409     long        num;
410     DWORD       pids[MAXIMUM_WAIT_OBJECTS];
411     HANDLE      handles[MAXIMUM_WAIT_OBJECTS];
412 } child_tab;
413
414 #ifdef USE_ITHREADS
415 typedef struct {
416     long        num;
417     DWORD       pids[MAXIMUM_WAIT_OBJECTS];
418     HANDLE      handles[MAXIMUM_WAIT_OBJECTS];
419     HWND        message_hwnds[MAXIMUM_WAIT_OBJECTS];
420     char        sigterm[MAXIMUM_WAIT_OBJECTS];
421 } pseudo_child_tab;
422 #endif
423
424 #ifndef Sighandler_t
425 typedef Signal_t (*Sighandler_t) (int);
426 #define Sighandler_t    Sighandler_t
427 #endif
428
429 struct interp_intern {
430     char *      perlshell_tokens;
431     char **     perlshell_vec;
432     long        perlshell_items;
433     struct av * fdpid;
434     child_tab * children;
435 #ifdef USE_ITHREADS
436     DWORD       pseudo_id;
437     pseudo_child_tab * pseudo_children;
438 #endif
439     void *      internal_host;
440     struct thread_intern        thr_intern;
441     HWND        message_hwnd;
442     UINT        timerid;
443     unsigned    poll_count;
444     Sighandler_t sigtable[SIG_SIZE];
445 };
446
447 DllExport int win32_async_check(pTHX);
448
449 #define WIN32_POLL_INTERVAL 32768
450 #define PERL_ASYNC_CHECK() if (w32_do_async || PL_sig_pending) win32_async_check(aTHX)
451
452 #define w32_perlshell_tokens    (PL_sys_intern.perlshell_tokens)
453 #define w32_perlshell_vec       (PL_sys_intern.perlshell_vec)
454 #define w32_perlshell_items     (PL_sys_intern.perlshell_items)
455 #define w32_fdpid               (PL_sys_intern.fdpid)
456 #define w32_children            (PL_sys_intern.children)
457 #define w32_num_children        (w32_children->num)
458 #define w32_child_pids          (w32_children->pids)
459 #define w32_child_handles       (w32_children->handles)
460 #define w32_pseudo_id           (PL_sys_intern.pseudo_id)
461 #define w32_pseudo_children     (PL_sys_intern.pseudo_children)
462 #define w32_num_pseudo_children         (w32_pseudo_children->num)
463 #define w32_pseudo_child_pids           (w32_pseudo_children->pids)
464 #define w32_pseudo_child_handles        (w32_pseudo_children->handles)
465 #define w32_pseudo_child_message_hwnds  (w32_pseudo_children->message_hwnds)
466 #define w32_pseudo_child_sigterm        (w32_pseudo_children->sigterm)
467 #define w32_internal_host               (PL_sys_intern.internal_host)
468 #define w32_timerid                     (PL_sys_intern.timerid)
469 #define w32_message_hwnd                (PL_sys_intern.message_hwnd)
470 #define w32_sighandler                  (PL_sys_intern.sigtable)
471 #define w32_poll_count                  (PL_sys_intern.poll_count)
472 #define w32_do_async                    (w32_poll_count++ > WIN32_POLL_INTERVAL)
473 #define w32_strerror_buffer     (PL_sys_intern.thr_intern.Wstrerror_buffer)
474 #define w32_getlogin_buffer     (PL_sys_intern.thr_intern.Wgetlogin_buffer)
475 #define w32_crypt_buffer        (PL_sys_intern.thr_intern.Wcrypt_buffer)
476 #define w32_servent             (PL_sys_intern.thr_intern.Wservent)
477 #define w32_init_socktype       (PL_sys_intern.thr_intern.Winit_socktype)
478 #define w32_use_showwindow      (PL_sys_intern.thr_intern.Wuse_showwindow)
479 #define w32_showwindow  (PL_sys_intern.thr_intern.Wshowwindow)
480
481 #ifdef USE_ITHREADS
482 void win32_wait_for_children(pTHX);
483 #  define PERL_WAIT_FOR_CHILDREN win32_wait_for_children(aTHX)
484 #endif
485
486 /* IO.xs and POSIX.xs define PERLIO_NOT_STDIO to 1 */
487 #if defined(PERL_EXT_IO) || defined(PERL_EXT_POSIX)
488 #undef  PERLIO_NOT_STDIO
489 #endif
490 #define PERLIO_NOT_STDIO 0
491
492 #include "perlio.h"
493
494 /*
495  * This provides a layer of functions and macros to ensure extensions will
496  * get to use the same RTL functions as the core.
497  */
498 #include "win32iop.h"
499
500 #define EXEC_ARGV_CAST(x) ((const char *const *) x)
501
502 DllExport void *win32_signal_context(void);
503 #define PERL_GET_SIG_CONTEXT win32_signal_context()
504
505 #ifdef UNDER_CE
506 #define Win_GetModuleHandle   XCEGetModuleHandleA
507 #define Win_GetProcAddress    XCEGetProcAddressA
508 #define Win_GetModuleFileName XCEGetModuleFileNameA
509 #define Win_CreateSemaphore   CreateSemaphoreW
510 #else
511 #define Win_GetModuleHandle   GetModuleHandle
512 #define Win_GetProcAddress    GetProcAddress
513 #define Win_GetModuleFileName GetModuleFileName
514 #define Win_CreateSemaphore   CreateSemaphore
515 #endif
516
517 #endif /* _INC_WIN32_PERL5 */
518