This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
a0d076109ce757dfc582add083b1460df2a9262b
[perl5.git] / win32 / win32.h
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  */
9 #ifndef  _INC_WIN32_PERL5
10 #define  _INC_WIN32_PERL5
11
12 #ifndef _WIN32_WINNT
13 #  define _WIN32_WINNT 0x0400     /* needed for TryEnterCriticalSection() etc. */
14 #endif
15
16 #if defined(PERL_OBJECT) || defined(PERL_IMPLICIT_SYS) || defined(PERL_CAPI)
17 #  define DYNAMIC_ENV_FETCH
18 #  define ENV_HV_NAME "___ENV_HV_NAME___"
19 #  define HAS_GETENV_LEN
20 #  define prime_env_iter()
21 #  define WIN32IO_IS_STDIO              /* don't pull in custom stdio layer */
22 #  define WIN32SCK_IS_STDSCK            /* don't pull in custom wsock layer */
23 #  ifdef PERL_GLOBAL_STRUCT
24 #    error PERL_GLOBAL_STRUCT cannot be defined with PERL_IMPLICIT_SYS
25 #  endif
26 #  define win32_get_privlib PerlEnv_lib_path
27 #  define win32_get_sitelib PerlEnv_sitelib_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 #endif
36
37 /* Define DllExport akin to perl's EXT, 
38  * If we are in the DLL or mimicing the DLL for Win95 work round
39  * then Export the symbol, 
40  * otherwise import it.
41  */
42
43 /* now even GCC supports __declspec() */
44
45 #if defined(PERL_OBJECT)
46 #define DllExport
47 #else
48 #if defined(PERLDLL) || defined(WIN95FIX)
49 #define DllExport
50 /*#define DllExport __declspec(dllexport)*/     /* noises with VC5+sp3 */
51 #else 
52 #define DllExport __declspec(dllimport)
53 #endif
54 #endif
55
56 #define  WIN32_LEAN_AND_MEAN
57 #include <windows.h>
58
59 #ifdef   WIN32_LEAN_AND_MEAN            /* C file is NOT a Perl5 original. */
60 #define  CONTEXT        PERL_CONTEXT    /* Avoid conflict of CONTEXT defs. */
61 #endif /*WIN32_LEAN_AND_MEAN */
62
63 #ifndef TLS_OUT_OF_INDEXES
64 #define TLS_OUT_OF_INDEXES (DWORD)0xFFFFFFFF
65 #endif
66
67 #include <dirent.h>
68 #include <io.h>
69 #include <process.h>
70 #include <stdio.h>
71 #include <direct.h>
72 #include <stdlib.h>
73 #include <fcntl.h>
74 #ifndef EXT
75 #include "EXTERN.h"
76 #endif
77
78 struct tms {
79         long    tms_utime;
80         long    tms_stime;
81         long    tms_cutime;
82         long    tms_cstime;
83 };
84
85 #ifndef SYS_NMLN
86 #define SYS_NMLN        257
87 #endif
88
89 struct utsname {
90     char sysname[SYS_NMLN];
91     char nodename[SYS_NMLN];
92     char release[SYS_NMLN];
93     char version[SYS_NMLN];
94     char machine[SYS_NMLN];
95 };
96
97 #ifndef START_EXTERN_C
98 #undef EXTERN_C
99 #ifdef __cplusplus
100 #  define START_EXTERN_C extern "C" {
101 #  define END_EXTERN_C }
102 #  define EXTERN_C extern "C"
103 #else
104 #  define START_EXTERN_C 
105 #  define END_EXTERN_C 
106 #  define EXTERN_C
107 #endif
108 #endif
109
110 #define  STANDARD_C     1
111 #define  DOSISH         1               /* no escaping our roots */
112 #define  OP_BINARY      O_BINARY        /* mistake in in pp_sys.c? */
113
114 /* Define USE_SOCKETS_AS_HANDLES to enable emulation of windows sockets as
115  * real filehandles. XXX Should always be defined (the other version is untested) */
116 #define USE_SOCKETS_AS_HANDLES
117
118 /* read() and write() aren't transparent for socket handles */
119 #define PERL_SOCK_SYSREAD_IS_RECV
120 #define PERL_SOCK_SYSWRITE_IS_SEND
121
122 #define PERL_NO_FORCE_LINK              /* no need for PL_force_link_funcs */
123
124 /* if USE_WIN32_RTL_ENV is not defined, Perl uses direct Win32 calls
125  * to read the environment, bypassing the runtime's (usually broken)
126  * facilities for accessing the same.  See note in util.c/my_setenv(). */
127 /*#define USE_WIN32_RTL_ENV */
128
129 /* Define USE_FIXED_OSFHANDLE to fix MSVCRT's _open_osfhandle() on W95.
130    It now uses some black magic to work seamlessly with the DLL CRT and
131    works with MSVC++ 4.0+ or GCC/Mingw32
132         -- BKS 1-24-2000 */
133 #if (defined(_M_IX86) && _MSC_VER >= 1000) || defined(__MINGW32__)
134 #define USE_FIXED_OSFHANDLE
135 #endif
136
137 #define ENV_IS_CASELESS
138
139 #ifndef VER_PLATFORM_WIN32_WINDOWS      /* VC-2.0 headers don't have this */
140 #define VER_PLATFORM_WIN32_WINDOWS      1
141 #endif
142
143 #ifndef FILE_SHARE_DELETE               /* VC-4.0 headers don't have this */
144 #define FILE_SHARE_DELETE               0x00000004
145 #endif
146
147 /* access() mode bits */
148 #ifndef R_OK
149 #  define       R_OK    4
150 #  define       W_OK    2
151 #  define       X_OK    1
152 #  define       F_OK    0
153 #endif
154
155 #define PERL_GET_CONTEXT_DEFINED
156
157 /* Compiler-specific stuff. */
158
159 #ifdef __BORLANDC__             /* Borland C++ */
160
161 #define _access access
162 #define _chdir chdir
163 #define _getpid getpid
164 #define wcsicmp _wcsicmp
165 #include <sys/types.h>
166
167 #ifndef DllMain
168 #define DllMain DllEntryPoint
169 #endif
170
171 #pragma warn -ccc       /* "condition is always true/false" */
172 #pragma warn -rch       /* "unreachable code" */
173 #pragma warn -sig       /* "conversion may lose significant digits" */
174 #pragma warn -pia       /* "possibly incorrect assignment" */
175 #pragma warn -par       /* "parameter 'foo' is never used" */
176 #pragma warn -aus       /* "'foo' is assigned a value that is never used" */
177 #pragma warn -use       /* "'foo' is declared but never used" */
178 #pragma warn -csu       /* "comparing signed and unsigned values" */
179 #pragma warn -pro       /* "call to function with no prototype" */
180 #pragma warn -stu       /* "undefined structure 'foo'" */
181
182 /* Borland is picky about a bare member function name used as its ptr */
183 #ifdef PERL_OBJECT
184 #  define MEMBER_TO_FPTR(name)  &(name)
185 #endif
186
187 /* Borland C thinks that a pointer to a member variable is 12 bytes in size. */
188 #define PERL_MEMBER_PTR_SIZE    12
189
190 #endif
191
192 #ifdef _MSC_VER                 /* Microsoft Visual C++ */
193
194 typedef long            uid_t;
195 typedef long            gid_t;
196 typedef unsigned short  mode_t;
197 #pragma  warning(disable: 4018 4035 4101 4102 4244 4245 4761)
198
199 /* Visual C thinks that a pointer to a member variable is 16 bytes in size. */
200 #define PERL_MEMBER_PTR_SIZE    16
201
202 #endif /* _MSC_VER */
203
204 #ifdef __MINGW32__              /* Minimal Gnu-Win32 */
205
206 typedef long            uid_t;
207 typedef long            gid_t;
208 #ifndef _environ
209 #define _environ        environ
210 #endif
211 #define flushall        _flushall
212 #define fcloseall       _fcloseall
213
214 #ifdef PERL_OBJECT
215 #  define MEMBER_TO_FPTR(name)  &(name)
216 #endif
217
218 #ifndef _O_NOINHERIT
219 #  define _O_NOINHERIT  0x0080
220 #  ifndef _NO_OLDNAMES
221 #    define O_NOINHERIT _O_NOINHERIT
222 #  endif
223 #endif
224
225 #endif /* __MINGW32__ */
226
227 /* both GCC/Mingw32 and MSVC++ 4.0 are missing this, so we put it here */
228 #ifndef CP_UTF8
229 #  define CP_UTF8       65001
230 #endif
231
232 /* compatibility stuff for other compilers goes here */
233
234
235 #if !defined(PERL_OBJECT) && defined(PERL_CAPI) && defined(PERL_MEMBER_PTR_SIZE)
236 #  define STRUCT_MGVTBL_DEFINITION \
237 struct mgvtbl {                                                         \
238     union {                                                             \
239         int         (CPERLscope(*svt_get))(pTHX_ SV *sv, MAGIC* mg);    \
240         char        handle_VC_problem1[PERL_MEMBER_PTR_SIZE];           \
241     };                                                                  \
242     union {                                                             \
243         int         (CPERLscope(*svt_set))(pTHX_ SV *sv, MAGIC* mg);    \
244         char        handle_VC_problem2[PERL_MEMBER_PTR_SIZE];           \
245     };                                                                  \
246     union {                                                             \
247         U32         (CPERLscope(*svt_len))(pTHX_ SV *sv, MAGIC* mg);    \
248         char        handle_VC_problem3[PERL_MEMBER_PTR_SIZE];           \
249     };                                                                  \
250     union {                                                             \
251         int         (CPERLscope(*svt_clear))(pTHX_ SV *sv, MAGIC* mg);  \
252         char        handle_VC_problem4[PERL_MEMBER_PTR_SIZE];           \
253     };                                                                  \
254     union {                                                             \
255         int         (CPERLscope(*svt_free))(pTHX_ SV *sv, MAGIC* mg);   \
256         char        handle_VC_problem5[PERL_MEMBER_PTR_SIZE];           \
257     };                                                                  \
258 }
259
260 #  define BASEOP_DEFINITION \
261     OP*         op_next;                                                \
262     OP*         op_sibling;                                             \
263     OP*         (CPERLscope(*op_ppaddr))(pTHX);                         \
264     char        handle_VC_problem[PERL_MEMBER_PTR_SIZE-sizeof(OP*)];    \
265     PADOFFSET   op_targ;                                                \
266     OPCODE      op_type;                                                \
267     U16         op_seq;                                                 \
268     U8          op_flags;                                               \
269     U8          op_private;
270
271 #endif /* !PERL_OBJECT && PERL_CAPI && PERL_MEMBER_PTR_SIZE */
272
273
274 START_EXTERN_C
275
276 /* For UNIX compatibility. */
277
278 extern  uid_t   getuid(void);
279 extern  gid_t   getgid(void);
280 extern  uid_t   geteuid(void);
281 extern  gid_t   getegid(void);
282 extern  int     setuid(uid_t uid);
283 extern  int     setgid(gid_t gid);
284 extern  int     kill(int pid, int sig);
285 extern  void    *sbrk(int need);
286 extern  char *  getlogin(void);
287 extern  int     chown(const char *p, uid_t o, gid_t g);
288
289 #undef   Stat
290 #define  Stat           win32_stat
291
292 #undef   init_os_extras
293 #define  init_os_extras Perl_init_os_extras
294
295 DllExport void          Perl_win32_init(int *argcp, char ***argvp);
296 DllExport void          Perl_init_os_extras();
297 DllExport void          win32_str_os_error(void *sv, DWORD err);
298 DllExport int           RunPerl(int argc, char **argv, char **env);
299
300 typedef struct {
301     HANDLE      childStdIn;
302     HANDLE      childStdOut;
303     HANDLE      childStdErr;
304 } child_IO_table;
305
306 DllExport void          win32_get_child_IO(child_IO_table* ptr);
307
308 #ifndef USE_SOCKETS_AS_HANDLES
309 extern FILE *           my_fdopen(int, char *);
310 #endif
311 extern int              my_fclose(FILE *);
312 extern int              do_aspawn(void *really, void **mark, void **sp);
313 extern int              do_spawn(char *cmd);
314 extern int              do_spawn_nowait(char *cmd);
315 extern char *           win32_get_privlib(char *pl);
316 extern char *           win32_get_sitelib(char *pl);
317 extern int              IsWin95(void);
318 extern int              IsWinNT(void);
319 extern void             win32_argv2utf8(int argc, char** argv);
320
321 extern char *           staticlinkmodules[];
322
323 END_EXTERN_C
324
325 typedef  char *         caddr_t;        /* In malloc.c (core address). */
326
327 /*
328  * handle socket stuff, assuming socket is always available
329  */
330 #include <sys/socket.h>
331 #include <netdb.h>
332
333 #ifdef MYMALLOC
334 #define EMBEDMYMALLOC   /**/
335 /* #define USE_PERL_SBRK        /**/
336 /* #define PERL_SBRK_VIA_MALLOC /**/
337 #endif
338
339 #if defined(PERLDLL) && !defined(PERL_CORE)
340 #define PERL_CORE
341 #endif
342
343 #ifdef PERL_TEXTMODE_SCRIPTS
344 #  define PERL_SCRIPT_MODE              "r"
345 #else
346 #  define PERL_SCRIPT_MODE              "rb"
347 #endif
348
349 /* 
350  * Now Win32 specific per-thread data stuff 
351  */
352
353 struct thread_intern {
354     /* XXX can probably use one buffer instead of several */
355     char                Wstrerror_buffer[512];
356     struct servent      Wservent;
357     char                Wgetlogin_buffer[128];
358 #    ifdef USE_SOCKETS_AS_HANDLES
359     int                 Winit_socktype;
360 #    endif
361 #    ifdef HAVE_DES_FCRYPT
362     char                Wcrypt_buffer[30];
363 #    endif
364 #    ifdef USE_RTL_THREAD_API
365     void *              retv;   /* slot for thread return value */
366 #    endif
367 };
368
369 #ifdef USE_THREADS
370 #  ifndef USE_DECLSPEC_THREAD
371 #    define HAVE_THREAD_INTERN
372 #  endif /* !USE_DECLSPEC_THREAD */
373 #endif /* USE_THREADS */
374
375 #define HAVE_INTERP_INTERN
376 typedef struct {
377     long        num;
378     DWORD       pids[MAXIMUM_WAIT_OBJECTS];
379     HANDLE      handles[MAXIMUM_WAIT_OBJECTS];
380 } child_tab;
381
382 struct interp_intern {
383     char *      perlshell_tokens;
384     char **     perlshell_vec;
385     long        perlshell_items;
386     struct av * fdpid;
387     child_tab * children;
388 #ifdef USE_ITHREADS
389     DWORD       pseudo_id;
390     child_tab * pseudo_children;
391 #endif
392     void *      internal_host;
393 #ifndef USE_THREADS
394     struct thread_intern        thr_intern;
395 #endif
396 };
397
398
399 #define w32_perlshell_tokens    (PL_sys_intern.perlshell_tokens)
400 #define w32_perlshell_vec       (PL_sys_intern.perlshell_vec)
401 #define w32_perlshell_items     (PL_sys_intern.perlshell_items)
402 #define w32_fdpid               (PL_sys_intern.fdpid)
403 #define w32_children            (PL_sys_intern.children)
404 #define w32_num_children        (w32_children->num)
405 #define w32_child_pids          (w32_children->pids)
406 #define w32_child_handles       (w32_children->handles)
407 #define w32_pseudo_id           (PL_sys_intern.pseudo_id)
408 #define w32_pseudo_children     (PL_sys_intern.pseudo_children)
409 #define w32_num_pseudo_children         (w32_pseudo_children->num)
410 #define w32_pseudo_child_pids           (w32_pseudo_children->pids)
411 #define w32_pseudo_child_handles        (w32_pseudo_children->handles)
412 #define w32_internal_host               (PL_sys_intern.internal_host)
413 #ifdef USE_THREADS
414 #  define w32_strerror_buffer   (thr->i.Wstrerror_buffer)
415 #  define w32_getlogin_buffer   (thr->i.Wgetlogin_buffer)
416 #  define w32_crypt_buffer      (thr->i.Wcrypt_buffer)
417 #  define w32_servent           (thr->i.Wservent)
418 #  define w32_init_socktype     (thr->i.Winit_socktype)
419 #else
420 #  define w32_strerror_buffer   (PL_sys_intern.thr_intern.Wstrerror_buffer)
421 #  define w32_getlogin_buffer   (PL_sys_intern.thr_intern.Wgetlogin_buffer)
422 #  define w32_crypt_buffer      (PL_sys_intern.thr_intern.Wcrypt_buffer)
423 #  define w32_servent           (PL_sys_intern.thr_intern.Wservent)
424 #  define w32_init_socktype     (PL_sys_intern.thr_intern.Winit_socktype)
425 #endif /* USE_THREADS */
426
427 /* UNICODE<>ANSI translation helpers */
428 /* Use CP_ACP when mode is ANSI */
429 /* Use CP_UTF8 when mode is UTF8 */
430
431 #define A2WHELPER_LEN(lpa, alen, lpw, nBytes)\
432     (lpw[0] = 0, MultiByteToWideChar((IN_BYTE) ? CP_ACP : CP_UTF8, 0, \
433                                     lpa, alen, lpw, (nBytes/sizeof(WCHAR))))
434 #define A2WHELPER(lpa, lpw, nBytes)     A2WHELPER_LEN(lpa, -1, lpw, nBytes)
435
436 #define W2AHELPER_LEN(lpw, wlen, lpa, nChars)\
437     (lpa[0] = '\0', WideCharToMultiByte((IN_BYTE) ? CP_ACP : CP_UTF8, 0, \
438                                        lpw, wlen, (LPSTR)lpa, nChars,NULL,NULL))
439 #define W2AHELPER(lpw, lpa, nChars)     W2AHELPER_LEN(lpw, -1, lpa, nChars)
440
441 #define USING_WIDE() (PL_widesyscalls && PerlEnv_os_id() == VER_PLATFORM_WIN32_NT)
442
443 #ifdef USE_ITHREADS
444 #  define PERL_WAIT_FOR_CHILDREN \
445     STMT_START {                                                        \
446         if (w32_pseudo_children && w32_num_pseudo_children) {           \
447             long children = w32_num_pseudo_children;                    \
448             WaitForMultipleObjects(children,                            \
449                                    w32_pseudo_child_handles,            \
450                                    TRUE, INFINITE);                     \
451             while (children)                                            \
452                 CloseHandle(w32_pseudo_child_handles[--children]);      \
453         }                                                               \
454     } STMT_END
455 #endif
456
457 /*
458  * This provides a layer of functions and macros to ensure extensions will
459  * get to use the same RTL functions as the core.
460  */
461 #include "win32iop.h"
462
463 #endif /* _INC_WIN32_PERL5 */
464