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