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