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