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 #ifndef CP_UTF8
 215 #  define CP_UTF8       65001
 216 #endif
 217
 218 #ifdef PERL_OBJECT
 219 #  define MEMBER_TO_FPTR(name)  &(name)
 220 #endif
 221
 222 #ifndef _O_NOINHERIT
 223 #  define _O_NOINHERIT  0x0080
 224 #  ifndef _NO_OLDNAMES
 225 #    define O_NOINHERIT _O_NOINHERIT
 226 #  endif
 227 #endif
 228
 229 #endif /* __MINGW32__ */
 230
 231 /* compatibility stuff for other compilers goes here */
 232
 233
 234 #if !defined(PERL_OBJECT) && defined(PERL_CAPI) && defined(PERL_MEMBER_PTR_SIZE)
 235 #  define STRUCT_MGVTBL_DEFINITION \
 236 struct mgvtbl {                                                         \
 237     union {                                                             \
 238         int         (CPERLscope(*svt_get))(pTHX_ SV *sv, MAGIC* mg);    \
 239         char        handle_VC_problem1[PERL_MEMBER_PTR_SIZE];           \
 240     };                                                                  \
 241     union {                                                             \
 242         int         (CPERLscope(*svt_set))(pTHX_ SV *sv, MAGIC* mg);    \
 243         char        handle_VC_problem2[PERL_MEMBER_PTR_SIZE];           \
 244     };                                                                  \
 245     union {                                                             \
 246         U32         (CPERLscope(*svt_len))(pTHX_ SV *sv, MAGIC* mg);    \
 247         char        handle_VC_problem3[PERL_MEMBER_PTR_SIZE];           \
 248     };                                                                  \
 249     union {                                                             \
 250         int         (CPERLscope(*svt_clear))(pTHX_ SV *sv, MAGIC* mg);  \
 251         char        handle_VC_problem4[PERL_MEMBER_PTR_SIZE];           \
 252     };                                                                  \
 253     union {                                                             \
 254         int         (CPERLscope(*svt_free))(pTHX_ SV *sv, MAGIC* mg);   \
 255         char        handle_VC_problem5[PERL_MEMBER_PTR_SIZE];           \
 256     };                                                                  \
 257 }
 258
 259 #  define BASEOP_DEFINITION \
 260     OP*         op_next;                                                \
 261     OP*         op_sibling;                                             \
 262     OP*         (CPERLscope(*op_ppaddr))(pTHX);                         \
 263     char        handle_VC_problem[PERL_MEMBER_PTR_SIZE-sizeof(OP*)];    \
 264     PADOFFSET   op_targ;                                                \
 265     OPCODE      op_type;                                                \
 266     U16         op_seq;                                                 \
 267     U8          op_flags;                                               \
 268     U8          op_private;
 269
 270 #endif /* !PERL_OBJECT && PERL_CAPI && PERL_MEMBER_PTR_SIZE */
 271
 272
 273 START_EXTERN_C
 274
 275 /* For UNIX compatibility. */
 276
 277 extern  uid_t   getuid(void);
 278 extern  gid_t   getgid(void);
 279 extern  uid_t   geteuid(void);
 280 extern  gid_t   getegid(void);
 281 extern  int     setuid(uid_t uid);
 282 extern  int     setgid(gid_t gid);
 283 extern  int     kill(int pid, int sig);
 284 extern  void    *sbrk(int need);
 285 extern  char *  getlogin(void);
 286 extern  int     chown(const char *p, uid_t o, gid_t g);
 287
 288 #undef   Stat
 289 #define  Stat           win32_stat
 290
 291 #undef   init_os_extras
 292 #define  init_os_extras Perl_init_os_extras
 293
 294 DllExport void          Perl_win32_init(int *argcp, char ***argvp);
 295 DllExport void          Perl_init_os_extras();
 296 DllExport void          win32_str_os_error(void *sv, DWORD err);
 297 DllExport int           RunPerl(int argc, char **argv, char **env);
 298
 299 typedef struct {
 300     HANDLE      childStdIn;
 301     HANDLE      childStdOut;
 302     HANDLE      childStdErr;
 303 } child_IO_table;
 304
 305 DllExport void          win32_get_child_IO(child_IO_table* ptr);
 306
 307 #ifndef USE_SOCKETS_AS_HANDLES
 308 extern FILE *           my_fdopen(int, char *);
 309 #endif
 310 extern int              my_fclose(FILE *);
 311 extern int              do_aspawn(void *really, void **mark, void **sp);
 312 extern int              do_spawn(char *cmd);
 313 extern int              do_spawn_nowait(char *cmd);
 314 extern char *           win32_get_privlib(char *pl);
 315 extern char *           win32_get_sitelib(char *pl);
 316 extern int              IsWin95(void);
 317 extern int              IsWinNT(void);
 318 extern void             win32_argv2utf8(int argc, char** argv);
 319
 320 extern char *           staticlinkmodules[];
 321
 322 END_EXTERN_C
 323
 324 typedef  char *         caddr_t;        /* In malloc.c (core address). */
 325
 326 /*
 327  * handle socket stuff, assuming socket is always available
 328  */
 329 #include <sys/socket.h>
 330 #include <netdb.h>
 331
 332 #ifdef MYMALLOC
 333 #define EMBEDMYMALLOC   /**/
 334 /* #define USE_PERL_SBRK        /**/
 335 /* #define PERL_SBRK_VIA_MALLOC /**/
 336 #endif
 337
 338 #if defined(PERLDLL) && !defined(PERL_CORE)
 339 #define PERL_CORE
 340 #endif
 341
 342 #ifdef PERL_TEXTMODE_SCRIPTS
 343 #  define PERL_SCRIPT_MODE              "r"
 344 #else
 345 #  define PERL_SCRIPT_MODE              "rb"
 346 #endif
 347
 348 /*
 349  * Now Win32 specific per-thread data stuff
 350  */
 351
 352 struct thread_intern {
 353     /* XXX can probably use one buffer instead of several */
 354     char                Wstrerror_buffer[512];
 355     struct servent      Wservent;
 356     char                Wgetlogin_buffer[128];
 357 #    ifdef USE_SOCKETS_AS_HANDLES
 358     int                 Winit_socktype;
 359 #    endif
 360 #    ifdef HAVE_DES_FCRYPT
 361     char                Wcrypt_buffer[30];
 362 #    endif
 363 #    ifdef USE_RTL_THREAD_API
 364     void *              retv;   /* slot for thread return value */
 365 #    endif
 366 };
 367
 368 #ifdef USE_THREADS
 369 #  ifndef USE_DECLSPEC_THREAD
 370 #    define HAVE_THREAD_INTERN
 371 #  endif /* !USE_DECLSPEC_THREAD */
 372 #endif /* USE_THREADS */
 373
 374 #define HAVE_INTERP_INTERN
 375 typedef struct {
 376     long        num;
 377     DWORD       pids[MAXIMUM_WAIT_OBJECTS];
 378     HANDLE      handles[MAXIMUM_WAIT_OBJECTS];
 379 } child_tab;
 380
 381 struct interp_intern {
 382     char *      perlshell_tokens;
 383     char **     perlshell_vec;
 384     long        perlshell_items;
 385     struct av * fdpid;
 386     child_tab * children;
 387 #ifdef USE_ITHREADS
 388     DWORD       pseudo_id;
 389     child_tab * pseudo_children;
 390 #endif
 391     void *      internal_host;
 392 #ifndef USE_THREADS
 393     struct thread_intern        thr_intern;
 394 #endif
 395 };
 396
 397
 398 #define w32_perlshell_tokens    (PL_sys_intern.perlshell_tokens)
 399 #define w32_perlshell_vec       (PL_sys_intern.perlshell_vec)
 400 #define w32_perlshell_items     (PL_sys_intern.perlshell_items)
 401 #define w32_fdpid               (PL_sys_intern.fdpid)
 402 #define w32_children            (PL_sys_intern.children)
 403 #define w32_num_children        (w32_children->num)
 404 #define w32_child_pids          (w32_children->pids)
 405 #define w32_child_handles       (w32_children->handles)
 406 #define w32_pseudo_id           (PL_sys_intern.pseudo_id)
 407 #define w32_pseudo_children     (PL_sys_intern.pseudo_children)
 408 #define w32_num_pseudo_children         (w32_pseudo_children->num)
 409 #define w32_pseudo_child_pids           (w32_pseudo_children->pids)
 410 #define w32_pseudo_child_handles        (w32_pseudo_children->handles)
 411 #define w32_internal_host               (PL_sys_intern.internal_host)
 412 #ifdef USE_THREADS
 413 #  define w32_strerror_buffer   (thr->i.Wstrerror_buffer)
 414 #  define w32_getlogin_buffer   (thr->i.Wgetlogin_buffer)
 415 #  define w32_crypt_buffer      (thr->i.Wcrypt_buffer)
 416 #  define w32_servent           (thr->i.Wservent)
 417 #  define w32_init_socktype     (thr->i.Winit_socktype)
 418 #else
 419 #  define w32_strerror_buffer   (PL_sys_intern.thr_intern.Wstrerror_buffer)
 420 #  define w32_getlogin_buffer   (PL_sys_intern.thr_intern.Wgetlogin_buffer)
 421 #  define w32_crypt_buffer      (PL_sys_intern.thr_intern.Wcrypt_buffer)
 422 #  define w32_servent           (PL_sys_intern.thr_intern.Wservent)
 423 #  define w32_init_socktype     (PL_sys_intern.thr_intern.Winit_socktype)
 424 #endif /* USE_THREADS */
 425
 426 /* UNICODE<>ANSI translation helpers */
 427 /* Use CP_ACP when mode is ANSI */
 428 /* Use CP_UTF8 when mode is UTF8 */
 429
 430 #define A2WHELPER_LEN(lpa, alen, lpw, nBytes)\
 431     (lpw[0] = 0, MultiByteToWideChar((IN_BYTE) ? CP_ACP : CP_UTF8, 0, \
 432                                     lpa, alen, lpw, (nBytes/sizeof(WCHAR))))
 433 #define A2WHELPER(lpa, lpw, nBytes)     A2WHELPER_LEN(lpa, -1, lpw, nBytes)
 434
 435 #define W2AHELPER_LEN(lpw, wlen, lpa, nChars)\
 436     (lpa[0] = '\0', WideCharToMultiByte((IN_BYTE) ? CP_ACP : CP_UTF8, 0, \
 437                                        lpw, wlen, (LPSTR)lpa, nChars,NULL,NULL))
 438 #define W2AHELPER(lpw, lpa, nChars)     W2AHELPER_LEN(lpw, -1, lpa, nChars)
 439
 440 #define USING_WIDE() (PL_widesyscalls && PerlEnv_os_id() == VER_PLATFORM_WIN32_NT)
 441
 442 #ifdef USE_ITHREADS
 443 #  define PERL_WAIT_FOR_CHILDREN \
 444     STMT_START {                                                        \
 445         if (w32_pseudo_children && w32_num_pseudo_children) {           \
 446             long children = w32_num_pseudo_children;                    \
 447             WaitForMultipleObjects(children,                            \
 448                                    w32_pseudo_child_handles,            \
 449                                    TRUE, INFINITE);                     \
 450             while (children)                                            \
 451                 CloseHandle(w32_pseudo_child_handles[--children]);      \
 452         }                                                               \
 453     } STMT_END
 454 #endif
 455
 456 /*
 457  * This provides a layer of functions and macros to ensure extensions will
 458  * get to use the same RTL functions as the core.
 459  */
 460 #include "win32iop.h"
 461
 462 #endif /* _INC_WIN32_PERL5 */
 463