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