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_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 or mimicing the DLL for Win95 work round
  45  * then Export the symbol,
  46  * otherwise import it.
  47  */
  48
  49 /* now even GCC supports __declspec() */
  50
  51 #if defined(PERLDLL) || defined(WIN95FIX)
  52 #define DllExport
  53 /*#define DllExport __declspec(dllexport)*/     /* noises with VC5+sp3 */
  54 #else
  55 #define DllExport __declspec(dllimport)
  56 #endif
  57
  58 #define  WIN32_LEAN_AND_MEAN
  59 #include <windows.h>
  60
  61 #ifdef   WIN32_LEAN_AND_MEAN            /* C file is NOT a Perl5 original. */
  62 #define  CONTEXT        PERL_CONTEXT    /* Avoid conflict of CONTEXT defs. */
  63 #endif /*WIN32_LEAN_AND_MEAN */
  64
  65 #ifndef TLS_OUT_OF_INDEXES
  66 #define TLS_OUT_OF_INDEXES (DWORD)0xFFFFFFFF
  67 #endif
  68
  69 #include <dirent.h>
  70 #include <io.h>
  71 #include <process.h>
  72 #include <stdio.h>
  73 #include <direct.h>
  74 #include <stdlib.h>
  75 #include <stddef.h>
  76 #include <fcntl.h>
  77 #ifndef EXT
  78 #include "EXTERN.h"
  79 #endif
  80
  81 struct tms {
  82         long    tms_utime;
  83         long    tms_stime;
  84         long    tms_cutime;
  85         long    tms_cstime;
  86 };
  87
  88 #ifndef SYS_NMLN
  89 #define SYS_NMLN        257
  90 #endif
  91
  92 struct utsname {
  93     char sysname[SYS_NMLN];
  94     char nodename[SYS_NMLN];
  95     char release[SYS_NMLN];
  96     char version[SYS_NMLN];
  97     char machine[SYS_NMLN];
  98 };
  99
 100 #ifndef START_EXTERN_C
 101 #undef EXTERN_C
 102 #ifdef __cplusplus
 103 #  define START_EXTERN_C extern "C" {
 104 #  define END_EXTERN_C }
 105 #  define EXTERN_C extern "C"
 106 #else
 107 #  define START_EXTERN_C
 108 #  define END_EXTERN_C
 109 #  define EXTERN_C
 110 #endif
 111 #endif
 112
 113 #define  STANDARD_C     1
 114 #define  DOSISH         1               /* no escaping our roots */
 115 #define  OP_BINARY      O_BINARY        /* mistake in in pp_sys.c? */
 116
 117 /* Define USE_SOCKETS_AS_HANDLES to enable emulation of windows sockets as
 118  * real filehandles. XXX Should always be defined (the other version is untested) */
 119 #define USE_SOCKETS_AS_HANDLES
 120
 121 /* read() and write() aren't transparent for socket handles */
 122 #define PERL_SOCK_SYSREAD_IS_RECV
 123 #define PERL_SOCK_SYSWRITE_IS_SEND
 124
 125 #define PERL_NO_FORCE_LINK              /* no need for PL_force_link_funcs */
 126
 127 /* Define USE_FIXED_OSFHANDLE to fix MSVCRT's _open_osfhandle() on W95.
 128    It now uses some black magic to work seamlessly with the DLL CRT and
 129    works with MSVC++ 4.0+ or GCC/Mingw32
 130         -- BKS 1-24-2000 */
 131 #if (defined(_M_IX86) && _MSC_VER >= 1000) || defined(__MINGW32__)
 132 #define USE_FIXED_OSFHANDLE
 133 #endif
 134
 135 /* Define PERL_WIN32_SOCK_DLOAD to have Perl dynamically load the winsock
 136    DLL when needed. Don't use if your compiler supports delayloading (ie, VC++ 6.0)
 137         -- BKS 5-29-2000 */
 138 #if !(defined(_M_IX86) && _MSC_VER >= 1200)
 139 #define PERL_WIN32_SOCK_DLOAD
 140 #endif
 141 #define ENV_IS_CASELESS
 142
 143 #ifndef VER_PLATFORM_WIN32_WINDOWS      /* VC-2.0 headers don't have this */
 144 #define VER_PLATFORM_WIN32_WINDOWS      1
 145 #endif
 146
 147 #ifndef FILE_SHARE_DELETE               /* VC-4.0 headers don't have this */
 148 #define FILE_SHARE_DELETE               0x00000004
 149 #endif
 150
 151 /* access() mode bits */
 152 #ifndef R_OK
 153 #  define       R_OK    4
 154 #  define       W_OK    2
 155 #  define       X_OK    1
 156 #  define       F_OK    0
 157 #endif
 158
 159 /* for waitpid() */
 160 #ifndef WNOHANG
 161 #  define WNOHANG       1
 162 #endif
 163
 164 #define PERL_GET_CONTEXT_DEFINED
 165
 166 /* Compiler-specific stuff. */
 167
 168 #ifdef __BORLANDC__             /* Borland C++ */
 169
 170 #if (__BORLANDC__ <= 0x520)
 171 #define _access access
 172 #define _chdir chdir
 173 #endif
 174
 175 #define _getpid getpid
 176 #define wcsicmp _wcsicmp
 177 #include <sys/types.h>
 178
 179 #ifndef DllMain
 180 #define DllMain DllEntryPoint
 181 #endif
 182
 183 #pragma warn -ccc       /* "condition is always true/false" */
 184 #pragma warn -rch       /* "unreachable code" */
 185 #pragma warn -sig       /* "conversion may lose significant digits" */
 186 #pragma warn -pia       /* "possibly incorrect assignment" */
 187 #pragma warn -par       /* "parameter 'foo' is never used" */
 188 #pragma warn -aus       /* "'foo' is assigned a value that is never used" */
 189 #pragma warn -use       /* "'foo' is declared but never used" */
 190 #pragma warn -csu       /* "comparing signed and unsigned values" */
 191
 192 /* Borland C thinks that a pointer to a member variable is 12 bytes in size. */
 193 #define PERL_MEMBER_PTR_SIZE    12
 194
 195 #define isnan           _isnan
 196
 197 #endif
 198
 199 #ifdef _MSC_VER                 /* Microsoft Visual C++ */
 200
 201 typedef long            uid_t;
 202 typedef long            gid_t;
 203 typedef unsigned short  mode_t;
 204 #pragma  warning(disable: 4102) /* "unreferenced label" */
 205
 206 /* Visual C thinks that a pointer to a member variable is 16 bytes in size. */
 207 #define PERL_MEMBER_PTR_SIZE    16
 208
 209 #define isnan           _isnan
 210
 211 #endif /* _MSC_VER */
 212
 213 #ifdef __MINGW32__              /* Minimal Gnu-Win32 */
 214
 215 typedef long            uid_t;
 216 typedef long            gid_t;
 217 #ifndef _environ
 218 #define _environ        environ
 219 #endif
 220 #define flushall        _flushall
 221 #define fcloseall       _fcloseall
 222 #define isnan           _isnan  /* ...same libraries as MSVC */
 223
 224 #ifndef _O_NOINHERIT
 225 #  define _O_NOINHERIT  0x0080
 226 #  ifndef _NO_OLDNAMES
 227 #    define O_NOINHERIT _O_NOINHERIT
 228 #  endif
 229 #endif
 230
 231 #endif /* __MINGW32__ */
 232
 233 /* both GCC/Mingw32 and MSVC++ 4.0 are missing this, so we put it here */
 234 #ifndef CP_UTF8
 235 #  define CP_UTF8       65001
 236 #endif
 237
 238 /* compatibility stuff for other compilers goes here */
 239
 240 #ifndef _INTPTR_T_DEFINED
 241 typedef int             intptr_t;
 242 #  define _INTPTR_T_DEFINED
 243 #endif
 244
 245 #ifndef _UINTPTR_T_DEFINED
 246 typedef unsigned int    uintptr_t;
 247 #  define _UINTPTR_T_DEFINED
 248 #endif
 249
 250 START_EXTERN_C
 251
 252 /* For UNIX compatibility. */
 253
 254 extern  uid_t   getuid(void);
 255 extern  gid_t   getgid(void);
 256 extern  uid_t   geteuid(void);
 257 extern  gid_t   getegid(void);
 258 extern  int     setuid(uid_t uid);
 259 extern  int     setgid(gid_t gid);
 260 extern  int     kill(int pid, int sig);
 261 #ifndef USE_PERL_SBRK
 262 extern  void    *sbrk(ptrdiff_t need);
 263 #  define HAS_SBRK_PROTO
 264 #endif
 265 extern  char *  getlogin(void);
 266 extern  int     chown(const char *p, uid_t o, gid_t g);
 267 extern  int     mkstemp(const char *path);
 268
 269 #undef   Stat
 270 #define  Stat           win32_stat
 271
 272 #undef   init_os_extras
 273 #define  init_os_extras Perl_init_os_extras
 274
 275 DllExport void          Perl_win32_init(int *argcp, char ***argvp);
 276 DllExport void          Perl_init_os_extras(void);
 277 DllExport void          win32_str_os_error(void *sv, DWORD err);
 278 DllExport int           RunPerl(int argc, char **argv, char **env);
 279
 280 typedef struct {
 281     HANDLE      childStdIn;
 282     HANDLE      childStdOut;
 283     HANDLE      childStdErr;
 284     /*
 285      * the following correspond to the fields of the same name
 286      * in the STARTUPINFO structure. Embedders can use these to
 287      * control the spawning process' look.
 288      * Example - to hide the window of the spawned process:
 289      *    dwFlags = STARTF_USESHOWWINDOW;
 290      *    wShowWindow = SW_HIDE;
 291      */
 292     DWORD       dwFlags;
 293     DWORD       dwX;
 294     DWORD       dwY;
 295     DWORD       dwXSize;
 296     DWORD       dwYSize;
 297     DWORD       dwXCountChars;
 298     DWORD       dwYCountChars;
 299     DWORD       dwFillAttribute;
 300     WORD        wShowWindow;
 301 } child_IO_table;
 302
 303 DllExport void          win32_get_child_IO(child_IO_table* ptr);
 304
 305 #ifndef USE_SOCKETS_AS_HANDLES
 306 extern FILE *           my_fdopen(int, char *);
 307 #endif
 308 extern int              my_fclose(FILE *);
 309 extern int              my_fstat(int fd, Stat_t *sbufptr);
 310 extern char *           win32_get_privlib(const char *pl);
 311 extern char *           win32_get_sitelib(const char *pl);
 312 extern char *           win32_get_vendorlib(const char *pl);
 313 extern int              IsWin95(void);
 314 extern int              IsWinNT(void);
 315 extern void             win32_argv2utf8(int argc, char** argv);
 316
 317 #ifdef PERL_IMPLICIT_SYS
 318 extern void             win32_delete_internal_host(void *h);
 319 #endif
 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     BOOL               Wuse_showwindow;
 368     WORD               Wshowwindow;
 369 };
 370
 371 #ifdef USE_5005THREADS
 372 #  ifndef USE_DECLSPEC_THREAD
 373 #    define HAVE_THREAD_INTERN
 374 #  endif /* !USE_DECLSPEC_THREAD */
 375 #endif /* USE_5005THREADS */
 376
 377 #define HAVE_INTERP_INTERN
 378 typedef struct {
 379     long        num;
 380     DWORD       pids[MAXIMUM_WAIT_OBJECTS];
 381     HANDLE      handles[MAXIMUM_WAIT_OBJECTS];
 382 } child_tab;
 383
 384 #ifndef Sighandler_t
 385 typedef Signal_t (*Sighandler_t) (int);
 386 #define Sighandler_t    Sighandler_t
 387 #endif
 388
 389 struct interp_intern {
 390     char *      perlshell_tokens;
 391     char **     perlshell_vec;
 392     long        perlshell_items;
 393     struct av * fdpid;
 394     child_tab * children;
 395 #ifdef USE_ITHREADS
 396     DWORD       pseudo_id;
 397     child_tab * pseudo_children;
 398 #endif
 399     void *      internal_host;
 400 #ifndef USE_5005THREADS
 401     struct thread_intern        thr_intern;
 402 #endif
 403     UINT        timerid;
 404     unsigned    poll_count;
 405     Sighandler_t sigtable[SIG_SIZE];
 406 };
 407
 408 DllExport int win32_async_check(pTHX);
 409
 410 #define WIN32_POLL_INTERVAL 32768
 411 #define PERL_ASYNC_CHECK() if (w32_do_async || PL_sig_pending) win32_async_check(aTHX)
 412
 413 #define w32_perlshell_tokens    (PL_sys_intern.perlshell_tokens)
 414 #define w32_perlshell_vec       (PL_sys_intern.perlshell_vec)
 415 #define w32_perlshell_items     (PL_sys_intern.perlshell_items)
 416 #define w32_fdpid               (PL_sys_intern.fdpid)
 417 #define w32_children            (PL_sys_intern.children)
 418 #define w32_num_children        (w32_children->num)
 419 #define w32_child_pids          (w32_children->pids)
 420 #define w32_child_handles       (w32_children->handles)
 421 #define w32_pseudo_id           (PL_sys_intern.pseudo_id)
 422 #define w32_pseudo_children     (PL_sys_intern.pseudo_children)
 423 #define w32_num_pseudo_children         (w32_pseudo_children->num)
 424 #define w32_pseudo_child_pids           (w32_pseudo_children->pids)
 425 #define w32_pseudo_child_handles        (w32_pseudo_children->handles)
 426 #define w32_internal_host               (PL_sys_intern.internal_host)
 427 #define w32_timerid                     (PL_sys_intern.timerid)
 428 #define w32_sighandler                  (PL_sys_intern.sigtable)
 429 #define w32_poll_count                  (PL_sys_intern.poll_count)
 430 #define w32_do_async                    (w32_poll_count++ > WIN32_POLL_INTERVAL)
 431 #ifdef USE_5005THREADS
 432 #  define w32_strerror_buffer   (thr->i.Wstrerror_buffer)
 433 #  define w32_getlogin_buffer   (thr->i.Wgetlogin_buffer)
 434 #  define w32_crypt_buffer      (thr->i.Wcrypt_buffer)
 435 #  define w32_servent           (thr->i.Wservent)
 436 #  define w32_init_socktype     (thr->i.Winit_socktype)
 437 #  define w32_use_showwindow    (thr->i.Wuse_showwindow)
 438 #  define w32_showwindow        (thr->i.Wshowwindow)
 439 #else
 440 #  define w32_strerror_buffer   (PL_sys_intern.thr_intern.Wstrerror_buffer)
 441 #  define w32_getlogin_buffer   (PL_sys_intern.thr_intern.Wgetlogin_buffer)
 442 #  define w32_crypt_buffer      (PL_sys_intern.thr_intern.Wcrypt_buffer)
 443 #  define w32_servent           (PL_sys_intern.thr_intern.Wservent)
 444 #  define w32_init_socktype     (PL_sys_intern.thr_intern.Winit_socktype)
 445 #  define w32_use_showwindow    (PL_sys_intern.thr_intern.Wuse_showwindow)
 446 #  define w32_showwindow        (PL_sys_intern.thr_intern.Wshowwindow)
 447 #endif /* USE_5005THREADS */
 448
 449 /* UNICODE<>ANSI translation helpers */
 450 /* Use CP_ACP when mode is ANSI */
 451 /* Use CP_UTF8 when mode is UTF8 */
 452
 453 #define A2WHELPER_LEN(lpa, alen, lpw, nBytes)\
 454     (lpw[0] = 0, MultiByteToWideChar((IN_BYTES) ? CP_ACP : CP_UTF8, 0, \
 455                                     lpa, alen, lpw, (nBytes/sizeof(WCHAR))))
 456 #define A2WHELPER(lpa, lpw, nBytes)     A2WHELPER_LEN(lpa, -1, lpw, nBytes)
 457
 458 #define W2AHELPER_LEN(lpw, wlen, lpa, nChars)\
 459     (lpa[0] = '\0', WideCharToMultiByte((IN_BYTES) ? CP_ACP : CP_UTF8, 0, \
 460                                        lpw, wlen, (LPSTR)lpa, nChars,NULL,NULL))
 461 #define W2AHELPER(lpw, lpa, nChars)     W2AHELPER_LEN(lpw, -1, lpa, nChars)
 462
 463 #define USING_WIDE() (PL_widesyscalls && PerlEnv_os_id() == VER_PLATFORM_WIN32_NT)
 464
 465 #ifdef USE_ITHREADS
 466 #  define PERL_WAIT_FOR_CHILDREN \
 467     STMT_START {                                                        \
 468         if (w32_pseudo_children && w32_num_pseudo_children) {           \
 469             long children = w32_num_pseudo_children;                    \
 470             WaitForMultipleObjects(children,                            \
 471                                    w32_pseudo_child_handles,            \
 472                                    TRUE, INFINITE);                     \
 473             while (children)                                            \
 474                 CloseHandle(w32_pseudo_child_handles[--children]);      \
 475         }                                                               \
 476     } STMT_END
 477 #endif
 478
 479 #if defined(USE_FIXED_OSFHANDLE) || defined(PERL_MSVCRT_READFIX)
 480 #ifdef PERL_CORE
 481
 482 /* C doesn't like repeat struct definitions */
 483 #ifndef _CRTIMP
 484 #define _CRTIMP __declspec(dllimport)
 485 #endif
 486
 487 /*
 488  * Control structure for lowio file handles
 489  */
 490 typedef struct {
 491     intptr_t osfhnd;/* underlying OS file HANDLE */
 492     char osfile;    /* attributes of file (e.g., open in text mode?) */
 493     char pipech;    /* one char buffer for handles opened on pipes */
 494     int lockinitflag;
 495     CRITICAL_SECTION lock;
 496 } ioinfo;
 497
 498
 499 /*
 500  * Array of arrays of control structures for lowio files.
 501  */
 502 EXTERN_C _CRTIMP ioinfo* __pioinfo[];
 503
 504 /*
 505  * Definition of IOINFO_L2E, the log base 2 of the number of elements in each
 506  * array of ioinfo structs.
 507  */
 508 #define IOINFO_L2E          5
 509
 510 /*
 511  * Definition of IOINFO_ARRAY_ELTS, the number of elements in ioinfo array
 512  */
 513 #define IOINFO_ARRAY_ELTS   (1 << IOINFO_L2E)
 514
 515 /*
 516  * Access macros for getting at an ioinfo struct and its fields from a
 517  * file handle
 518  */
 519 #define _pioinfo(i) (__pioinfo[(i) >> IOINFO_L2E] + ((i) & (IOINFO_ARRAY_ELTS - 1)))
 520 #define _osfhnd(i)  (_pioinfo(i)->osfhnd)
 521 #define _osfile(i)  (_pioinfo(i)->osfile)
 522 #define _pipech(i)  (_pioinfo(i)->pipech)
 523
 524 /* since we are not doing a dup2(), this works fine */
 525 #define _set_osfhnd(fh, osfh) (void)(_osfhnd(fh) = (intptr_t)osfh)
 526 #endif
 527 #endif
 528
 529 /* IO.xs and POSIX.xs define PERLIO_NOT_STDIO to 1 */
 530 #if defined(PERL_EXT_IO) || defined(PERL_EXT_POSIX)
 531 #undef  PERLIO_NOT_STDIO
 532 #endif
 533 #define PERLIO_NOT_STDIO 0
 534
 535 #include "perlio.h"
 536
 537 /*
 538  * This provides a layer of functions and macros to ensure extensions will
 539  * get to use the same RTL functions as the core.
 540  */
 541 #include "win32iop.h"
 542
 543 #define EXEC_ARGV_CAST(x) ((const char *const *) x)
 544
 545 #if !defined(ECONNABORTED) && defined(WSAECONNABORTED)
 546 #define ECONNABORTED WSAECONNABORTED
 547 #endif
 548 #if !defined(EAFNOSUPPORT) && defined(WSAEAFNOSUPPORT)
 549 #define EAFNOSUPPORT WSAEAFNOSUPPORT
 550 #endif
 551
 552 DllExport void *win32_signal_context(void);
 553 #define PERL_GET_SIG_CONTEXT win32_signal_context()
 554
 555 #endif /* _INC_WIN32_PERL5 */
 556