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