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