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