vms/vmsish.h

   1 /*  vmsish.h
   2  *
   3  * VMS-specific C header file for perl5.
   4  *
   5  * Last revised: 16-Sep-1998 by Charles Bailey  bailey@newman.upenn.edu
   6  * Version: 5.5.2
   7  */
   8
   9 #ifndef __vmsish_h_included
  10 #define __vmsish_h_included
  11
  12 #include <descrip.h> /* for dirent struct definitions */
  13 #include <libdef.h>  /* status codes for various places */
  14 #include <rmsdef.h>  /* at which errno and vaxc$errno are */
  15 #include <ssdef.h>   /* explicitly set in the perl source code */
  16 #include <stsdef.h>  /* bitmasks for exit status testing */
  17
  18 /* Suppress compiler warnings from DECC for VMS-specific extensions:
  19  * ADDRCONSTEXT,NEEDCONSTEXT: initialization of data with non-constant values
  20  *                            (e.g. pointer fields of descriptors)
  21  */
  22 #ifdef __DECC
  23 #  pragma message disable (ADDRCONSTEXT,NEEDCONSTEXT)
  24 #endif
  25
  26 /* DEC's C compilers and gcc use incompatible definitions of _to(upp|low)er() */
  27 #ifdef _toupper
  28 #  undef _toupper
  29 #endif
  30 #define _toupper(c) (((c) < 'a' || (c) > 'z') ? (c) : (c) & ~040)
  31 #ifdef _tolower
  32 #  undef _tolower
  33 #endif
  34 #define _tolower(c) (((c) < 'A' || (c) > 'Z') ? (c) : (c) | 040)
  35 /* DECC 1.3 has a funny definition of abs; it's fixed in DECC 4.0, so this
  36  * can go away once DECC 1.3 isn't in use any more. */
  37 #if defined(__ALPHA) && defined(__DECC)
  38 #undef abs
  39 #define abs(__x)        __ABS(__x)
  40 #undef labs
  41 #define labs(__x)        __LABS(__x)
  42 #endif /* __ALPHA && __DECC */
  43
  44 /* Assorted things to look like Unix */
  45 #ifdef __GNUC__
  46 #ifndef _IOLBF /* gcc's stdio.h doesn't define this */
  47 #define _IOLBF 1
  48 #endif
  49 #endif
  50 #include <processes.h> /* for vfork() */
  51 #include <unixio.h>
  52 #include <unixlib.h>
  53 #include <file.h>  /* it's not <sys/file.h>, so don't use I_SYS_FILE */
  54 #if defined(__DECC) && defined(__DECC_VER) && __DECC_VER > 20000000
  55 #  include <unistd.h> /* DECC has this; VAXC and gcc don't */
  56 #endif
  57
  58 /* VAXC doesn't have a unary plus operator, so we need to get there indirectly */
  59 #if defined(VAXC) && !defined(__DECC)
  60 #  define NO_UNARY_PLUS
  61 #endif
  62
  63 #ifdef NO_PERL_TYPEDEFS /* a2p; we don't want Perl's special routines */
  64 #  define DONT_MASK_RTL_CALLS
  65 #endif
  66
  67 /* Note that we do, in fact, have this */
  68 #define HAS_GETENV_SV
  69 #define HAS_GETENV_LEN
  70
  71 #ifndef DONT_MASK_RTL_CALLS
  72 #  ifdef getenv
  73 #    undef getenv
  74 #  endif
  75   /* getenv used for regular logical names */
  76 #  define getenv(v) my_getenv(v,TRUE)
  77 #endif
  78 #ifdef getenv_len
  79 #  undef getenv_len
  80 #endif
  81 #define getenv_len(v,l) my_getenv_len(v,l,TRUE)
  82
  83 /* DECC introduces this routine in the RTL as of VMS 7.0; for now,
  84  * we'll use ours, since it gives us the full VMS exit status. */
  85 #define waitpid my_waitpid
  86
  87 /* Don't redeclare standard RTL routines in Perl's header files;
  88  * VMS history or extensions makes some of the formal protoypes
  89  * differ from the common Unix forms.
  90  */
  91 #define DONT_DECLARE_STD 1
  92
  93 /* Our own contribution to PerlShr's global symbols . . . */
  94 #define my_getenv_len           Perl_my_getenv_len
  95 #define prime_env_iter  Perl_prime_env_iter
  96 #define vmssetenv               Perl_vmssetenv
  97 #if !defined(PERL_IMPLICIT_CONTEXT)
  98 #define my_trnlnm               Perl_my_trnlnm
  99 #define vmstrnenv               Perl_vmstrnenv
 100 #define my_setenv               Perl_my_setenv
 101 #define my_getenv               Perl_my_getenv
 102 #define tounixspec              Perl_tounixspec
 103 #define tounixspec_ts           Perl_tounixspec_ts
 104 #define tovmsspec               Perl_tovmsspec
 105 #define tovmsspec_ts            Perl_tovmsspec_ts
 106 #define tounixpath              Perl_tounixpath
 107 #define tounixpath_ts           Perl_tounixpath_ts
 108 #define tovmspath               Perl_tovmspath
 109 #define tovmspath_ts            Perl_tovmspath_ts
 110 #define do_rmdir                Perl_do_rmdir
 111 #define fileify_dirspec         Perl_fileify_dirspec
 112 #define fileify_dirspec_ts      Perl_fileify_dirspec_ts
 113 #define pathify_dirspec         Perl_pathify_dirspec
 114 #define pathify_dirspec_ts      Perl_pathify_dirspec_ts
 115 #define trim_unixpath           Perl_trim_unixpath
 116 #define opendir                 Perl_opendir
 117 #define rmscopy                 Perl_rmscopy
 118 #else
 119 #define my_trnlnm(a,b,c)        Perl_my_trnlnm(aTHX_ a,b,c)
 120 #define vmstrnenv(a,b,c,d,e)    Perl_vmstrnenv(aTHX_ a,b,c,d,e)
 121 #define my_setenv(a,b)          Perl_my_setenv(aTHX_ a,b)
 122 #define my_getenv(a,b)          Perl_my_getenv(aTHX_ a,b)
 123 #define tounixspec(a,b)         Perl_tounixspec(aTHX_ a,b)
 124 #define tounixspec_ts(a,b)      Perl_tounixspec_ts(aTHX_ a,b)
 125 #define tovmsspec(a,b)          Perl_tovmsspec(aTHX_ a,b)
 126 #define tovmsspec_t(a,b)        Perl_tovmsspec_ts(aTHX_ a,b)
 127 #define tounixpath(a,b)         Perl_tounixpath(aTHX_ a,b)
 128 #define tounixpath_ts(a,b)      Perl_tounixpath_ts(aTHX_ a,b)
 129 #define tovmspath(a,b)          Perl_tovmspath(aTHX_ a,b)
 130 #define tovmspath_ts(a,b)       Perl_tovmspath_ts(aTHX_ a,b)
 131 #define do_rmdir(a)             Perl_do_rmdir(aTHX_ a)
 132 #define fileify_dirspec(a,b)    Perl_fileify_dirspec(aTHX_ a,b)
 133 #define fileify_dirspec_ts(a,b) Perl_fileify_dirspec_ts(aTHX_ a,b)
 134 #define pathify_dirspec         Perl_pathify_dirspec
 135 #define pathify_dirspec_ts      Perl_pathify_dirspec_ts
 136 #define rmsexpand(a,b,c,d)      Perl_rmsexpand(aTHX_ a,b,c,d)
 137 #define rmsexpand_ts(a,b,c,d)   Perl_rmsexpand_ts(aTHX_ a,b,c,d)
 138 #define trim_unixpath(a,b,c)    Perl_trim_unixpath(aTHX_ a,b,c)
 139 #define opendir(a)              Perl_opendir(aTHX_ a)
 140 #define rmscopy(a,b,c)          Perl_rmscopy(aTHX_ a,b,c)
 141 #endif
 142 #define my_crypt                Perl_my_crypt
 143 #define my_waitpid              Perl_my_waitpid
 144 #define my_gconvert             Perl_my_gconvert
 145 #define kill_file               Perl_kill_file
 146 #define my_mkdir                Perl_my_mkdir
 147 #define my_chdir                Perl_my_chdir
 148 #define my_tmpfile              Perl_my_tmpfile
 149 #define my_utime                Perl_my_utime
 150 #define vms_image_init  Perl_vms_image_init
 151 #define readdir         Perl_readdir
 152 #define telldir         Perl_telldir
 153 #define seekdir         Perl_seekdir
 154 #define closedir                Perl_closedir
 155 #define vmsreaddirversions      Perl_vmsreaddirversions
 156 #define my_gmtime               Perl_my_gmtime
 157 #define my_localtime            Perl_my_localtime
 158 #define my_time         Perl_my_time
 159 #define my_sigemptyset        Perl_my_sigemptyset
 160 #define my_sigfillset         Perl_my_sigfillset
 161 #define my_sigaddset          Perl_my_sigaddset
 162 #define my_sigdelset          Perl_my_sigdelset
 163 #define my_sigismember        Perl_my_sigismember
 164 #define my_sigprocmask        Perl_my_sigprocmask
 165 #define cando_by_name           Perl_cando_by_name
 166 #define flex_fstat              Perl_flex_fstat
 167 #define flex_stat               Perl_flex_stat
 168 #define my_vfork                Perl_my_vfork
 169 #define vms_do_aexec            Perl_vms_do_aexec
 170 #define vms_do_exec             Perl_vms_do_exec
 171 #define do_aspawn               Perl_do_aspawn
 172 #define do_spawn                Perl_do_spawn
 173 #define my_fwrite               Perl_my_fwrite
 174 #define my_flush                Perl_my_flush
 175 #define my_getpwnam             Perl_my_getpwnam
 176 #define my_getpwuid             Perl_my_getpwuid
 177 #define my_getpwent             Perl_my_getpwent
 178 #define my_endpwent             Perl_my_endpwent
 179 #define my_getlogin             Perl_my_getlogin
 180 #define init_os_extras  Perl_init_os_extras
 181
 182 /* Delete if at all possible, changing protections if necessary. */
 183 #define unlink kill_file
 184
 185 /*
 186  * Intercept calls to fork, so we know whether subsequent calls to
 187  * exec should be handled in VMSish or Unixish style.
 188  */
 189 #define fork my_vfork
 190 #ifndef DONT_MASK_RTL_CALLS     /* #defined in vms.c so we see real vfork */
 191 #  ifdef vfork
 192 #    undef vfork
 193 #  endif
 194 #  define vfork my_vfork
 195 #endif
 196
 197 /*
 198  * Toss in a shim to tmpfile which creates a plain temp file if the
 199  * RMS tmp mechanism won't work (e.g. if someone is relying on ACLs
 200  * from a specific directory to permit creation of files).
 201  */
 202 #ifndef DONT_MASK_RTL_CALLS
 203 #  define tmpfile my_tmpfile
 204 #endif
 205
 206
 207 /* BIG_TIME:
 208  *      This symbol is defined if Time_t is an unsigned type on this system.
 209  */
 210 #define BIG_TIME
 211
 212 /* ACME_MESS:
 213  *      This symbol, if defined, indicates that error messages should be
 214  *      should be generated in a format that allows the use of the Acme
 215  *      GUI/editor's autofind feature.
 216  */
 217 #undef ACME_MESS        /**/
 218
 219 /* ALTERNATE_SHEBANG:
 220  *      This symbol, if defined, contains a "magic" string which may be used
 221  *      as the first line of a Perl program designed to be executed directly
 222  *      by name, instead of the standard Unix #!.  If ALTERNATE_SHEBANG
 223  *      begins with a character other then #, then Perl will only treat
 224  *      it as a command line if if finds the string "perl" in the first
 225  *      word; otherwise it's treated as the first line of code in the script.
 226  *      (IOW, Perl won't hand off to another interpreter via an alternate
 227  *      shebang sequence that might be legal Perl code.)
 228  */
 229 #define ALTERNATE_SHEBANG "$"
 230
 231 /* Lower case entry points for these are missing in some earlier RTLs
 232  * so we borrow the defines and declares from errno.h and upcase them.
 233  */
 234 #if defined(VMS_WE_ARE_CASE_SENSITIVE) && (__DECC_VER < 50500000)
 235 #  define errno      (*CMA$TIS_ERRNO_GET_ADDR())
 236 #  define vaxc$errno (*CMA$TIS_VMSERRNO_GET_ADDR())
 237    int *CMA$TIS_ERRNO_GET_ADDR     (void);   /* UNIX style error code        */
 238    int *CMA$TIS_VMSERRNO_GET_ADDR  (void);   /* VMS error (errno == EVMSERR) */
 239 #endif
 240
 241 /* Macros to set errno using the VAX thread-safe calls, if present */
 242 #if (defined(__DECC) || defined(__DECCXX)) && !defined(__ALPHA)
 243 #  define set_errno(v)      (cma$tis_errno_set_value(v))
 244    void cma$tis_errno_set_value(int __value);  /* missing in some errno.h */
 245 #  define set_vaxc_errno(v) (vaxc$errno = (v))
 246 #else
 247 #  define set_errno(v)      (errno = (v))
 248 #  define set_vaxc_errno(v) (vaxc$errno = (v))
 249 #endif
 250
 251 /* Support for 'vmsish' behaviors enabled with C<use vmsish> pragma */
 252
 253 #define COMPLEX_STATUS  1       /* We track both "POSIX" and VMS values */
 254
 255 #define HINT_V_VMSISH           24
 256 #define HINT_M_VMSISH_HUSHED    0x20000000 /* stifle error msgs on exit */
 257 #define HINT_M_VMSISH_STATUS    0x40000000 /* system, $? return VMS status */
 258 #define HINT_M_VMSISH_TIME      0x80000000 /* times are local, not UTC */
 259 #define NATIVE_HINTS            (PL_hints >> HINT_V_VMSISH)  /* used in op.c */
 260
 261 #define TEST_VMSISH(h)  (PL_curcop->op_private & ((h) >> HINT_V_VMSISH))
 262 #define VMSISH_HUSHED   TEST_VMSISH(HINT_M_VMSISH_HUSHED)
 263 #define VMSISH_STATUS   TEST_VMSISH(HINT_M_VMSISH_STATUS)
 264 #define VMSISH_TIME     TEST_VMSISH(HINT_M_VMSISH_TIME)
 265
 266 /* Flags for vmstrnenv() */
 267 #define PERL__TRNENV_SECURE 0x01
 268
 269 /* Handy way to vet calls to VMS system services and RTL routines. */
 270 #define _ckvmssts(call) STMT_START { register unsigned long int __ckvms_sts; \
 271   if (!((__ckvms_sts=(call))&1)) { \
 272   set_errno(EVMSERR); set_vaxc_errno(__ckvms_sts); \
 273   Perl_croak(aTHX_ "Fatal VMS error (status=%d) at %s, line %d", \
 274   __ckvms_sts,__FILE__,__LINE__); } } STMT_END
 275
 276 /* Same thing, but don't call back to Perl's croak(); useful for errors
 277  * occurring during startup, before Perl's state is initialized */
 278 #define _ckvmssts_noperl(call) STMT_START { register unsigned long int __ckvms_sts; \
 279   if (!((__ckvms_sts=(call))&1)) { \
 280   set_errno(EVMSERR); set_vaxc_errno(__ckvms_sts); \
 281   fprintf(Perl_debug_log,"Fatal VMS error (status=%d) at %s, line %d", \
 282   __ckvms_sts,__FILE__,__LINE__); lib$signal(__ckvms_sts); } } STMT_END
 283
 284 #ifdef VMS_DO_SOCKETS
 285 #include "sockadapt.h"
 286 #define PERL_SOCK_SYSREAD_IS_RECV
 287 #define PERL_SOCK_SYSWRITE_IS_SEND
 288 #endif
 289
 290 #define BIT_BUCKET "_NLA0:"
 291 #define PERL_SYS_INIT(c,v)      vms_image_init((c),(v)); MALLOC_INIT
 292 #define PERL_SYS_TERM()         OP_REFCNT_TERM; MALLOC_TERM
 293 #define dXSUB_SYS
 294 #define HAS_KILL
 295 #define HAS_WAIT
 296
 297 #define PERL_FS_VER_FMT         "%d_%d_%d"
 298 /* Temporary; we need to add support for this to Configure.Com */
 299 #ifdef PERL_INC_VERSION_LIST
 300 #  undef PERL_INC_VERSION_LIST
 301 #endif
 302
 303 /* VMS:
 304  *      This symbol, if defined, indicates that the program is running under
 305  *      VMS.  It's a symbol automagically defined by all VMS C compilers I've seen.
 306  * Just in case, however . . . */
 307 #ifndef VMS
 308 #define VMS             /**/
 309 #endif
 310
 311 /* HAS_IOCTL:
 312  *      This symbol, if defined, indicates that the ioctl() routine is
 313  *      available to set I/O characteristics
 314  */
 315 #undef  HAS_IOCTL               /**/
 316
 317 /* HAS_UTIME:
 318  *      This symbol, if defined, indicates that the routine utime() is
 319  *      available to update the access and modification times of files.
 320  */
 321 #define HAS_UTIME               /**/
 322
 323 /* HAS_GROUP
 324  *      This symbol, if defined, indicates that the getgrnam() and
 325  *      getgrgid() routines are available to get group entries.
 326  *      The getgrent() has a separate definition, HAS_GETGRENT.
 327  */
 328 #undef HAS_GROUP                /**/
 329
 330 /* HAS_PASSWD
 331  *      This symbol, if defined, indicates that the getpwnam() and
 332  *      getpwuid() routines are available to get password entries.
 333  *      The getpwent() has a separate definition, HAS_GETPWENT.
 334  */
 335 #define HAS_PASSWD              /**/
 336
 337 #define HAS_KILL
 338 #define HAS_WAIT
 339
 340 /* USEMYBINMODE
 341  *      This symbol, if defined, indicates that the program should
 342  *      use the routine my_binmode(FILE *fp, char iotype, int mode) to insure
 343  *      that a file is in "binary" mode -- that is, that no translation
 344  *      of bytes occurs on read or write operations.
 345  */
 346 #undef USEMYBINMODE
 347
 348 /* Stat_t:
 349  *      This symbol holds the type used to declare buffers for information
 350  *      returned by stat().  It's usually just struct stat.  It may be necessary
 351  *      to include <sys/stat.h> and <sys/types.h> to get any typedef'ed
 352  *      information.
 353  */
 354 /* VMS:
 355  * We need this typedef to point to the new type even if DONT_MASK_RTL_CALLS
 356  * is in effect, since Perl's thread.h embeds one of these structs in its
 357  * thread data struct, and our struct mystat is a different size from the
 358  * regular struct stat (cf. note above about having to pad struct to work
 359  * around bug in compiler.)
 360  * It's OK to pass one of these to the RTL's stat(), though, since the
 361  * fields it fills are the same in each struct.
 362  */
 363 #define Stat_t struct mystat
 364
 365 /* USE_STAT_RDEV:
 366 *       This symbol is defined if this system has a stat structure declaring
 367 *       st_rdev
 368 *       VMS: Field exists in POSIXish version of struct stat(), but is not used.
 369 */
 370 #undef USE_STAT_RDEV            /**/
 371
 372 /*
 373  * fwrite1() should be a routine with the same calling sequence as fwrite(),
 374  * but which outputs all of the bytes requested as a single stream (unlike
 375  * fwrite() itself, which on some systems outputs several distinct records
 376  * if the number_of_items parameter is >1).
 377  */
 378 #define fwrite1 my_fwrite
 379
 380 /* By default, flush data all the way to disk, not just to RMS buffers */
 381 #define Fflush(fp) my_flush(fp)
 382
 383 /* Use our own rmdir() */
 384 #define rmdir(name) do_rmdir(name)
 385
 386 /* Assorted fiddling with sigs . . . */
 387 # include <signal.h>
 388 #define ABORT() abort()
 389     /* VAXC's signal.h doesn't #define SIG_ERR, but provides BADSIG instead. */
 390 #if !defined(SIG_ERR) && defined(BADSIG)
 391 #  define SIG_ERR BADSIG
 392 #endif
 393
 394
 395 /* Used with our my_utime() routine in vms.c */
 396 struct utimbuf {
 397   time_t actime;
 398   time_t modtime;
 399 };
 400 #define utime my_utime
 401
 402 /* This is what times() returns, but <times.h> calls it tbuffer_t on VMS
 403  * prior to v7.0.  We check the DECC manifest to see whether it's already
 404  * done this for us, relying on the fact that perl.h #includes <time.h>
 405  * before it #includes "vmsish.h".
 406  */
 407
 408 #ifndef __TMS
 409   struct tms {
 410     clock_t tms_utime;    /* user time */
 411     clock_t tms_stime;    /* system time - always 0 on VMS */
 412     clock_t tms_cutime;   /* user time, children */
 413     clock_t tms_cstime;   /* system time, children - always 0 on VMS */
 414   };
 415 #else
 416    /* The new headers change the times() prototype to tms from tbuffer */
 417 #  define tbuffer_t struct tms
 418 #endif
 419
 420 /* Substitute our own routines for gmtime(), localtime(), and time(),
 421  * which allow us to implement the vmsish 'time' pragma, and work
 422  * around absence of system-level UTC support on old versions of VMS.
 423  */
 424 #define gmtime(t) my_gmtime(t)
 425 #define localtime(t) my_localtime(t)
 426 #define time(t) my_time(t)
 427
 428 /* If we're using an older version of VMS whose Unix signal emulation
 429  * isn't very POSIXish, then roll our own.
 430  */
 431 #if __VMS_VER < 70000000 || __DECC_VER < 50200000
 432 #  define HOMEGROWN_POSIX_SIGNALS
 433 #endif
 434 #ifdef HOMEGROWN_POSIX_SIGNALS
 435 #  define sigemptyset(t) my_sigemptyset(t)
 436 #  define sigfillset(t) my_sigfillset(t)
 437 #  define sigaddset(t, u) my_sigaddset(t, u)
 438 #  define sigdelset(t, u) my_sigdelset(t, u)
 439 #  define sigismember(t, u) my_sigismember(t, u)
 440 #  define sigprocmask(t, u, v) my_sigprocmask(t, u, v)
 441 #  ifndef _SIGSET_T
 442    typedef int sigset_t;
 443 #  endif
 444    /* The tools for sigprocmask() are there, just not the routine itself */
 445 #  ifndef SIG_UNBLOCK
 446 #    define SIG_UNBLOCK 1
 447 #  endif
 448 #  ifndef SIG_BLOCK
 449 #    define SIG_BLOCK 2
 450 #  endif
 451 #  ifndef SIG_SETMASK
 452 #    define SIG_SETMASK 3
 453 #  endif
 454 #  define sigaction sigvec
 455 #  define sa_flags sv_onstack
 456 #  define sa_handler sv_handler
 457 #  define sa_mask sv_mask
 458 #  define sigsuspend(set) sigpause(*set)
 459 #  define sigpending(a) (not_here("sigpending"),0)
 460 #endif
 461
 462 /* VMS doesn't use a real sys_nerr, but we need this when scanning for error
 463  * messages in text strings . . .
 464  */
 465
 466 #define sys_nerr EVMSERR  /* EVMSERR is as high as we can go. */
 467
 468 /* Look up new %ENV values on the fly */
 469 #define DYNAMIC_ENV_FETCH 1
 470 #define ENV_HV_NAME "%EnV%VmS%"
 471   /* Special getenv function for retrieving %ENV elements. */
 472 #define ENVgetenv(v) my_getenv(v,FALSE)
 473 #define ENVgetenv_len(v,l) my_getenv_len(v,l,FALSE)
 474
 475
 476 /* Thin jacket around cuserid() tomatch Unix' calling sequence */
 477 #define getlogin my_getlogin
 478
 479 /* Ditto for sys$hash_passwrod() . . . */
 480 #define crypt  my_crypt
 481
 482 /* Tweak arg to mkdir & chdir first, so we can tolerate trailing /. */
 483 #define Mkdir(dir,mode) my_mkdir((dir),(mode))
 484 #define Chdir(dir) my_chdir((dir))
 485
 486 /* Use our own stat() clones, which handle Unix-style directory names */
 487 #define Stat(name,bufptr) flex_stat(name,bufptr)
 488 #define Fstat(fd,bufptr) flex_fstat(fd,bufptr)
 489
 490 /* Setup for the dirent routines:
 491  * opendir(), closedir(), readdir(), seekdir(), telldir(), and
 492  * vmsreaddirversions(), and preprocessor stuff on which these depend:
 493  *    Written by Rich $alz, <rsalz@bbn.com> in August, 1990.
 494  */
 495     /* Data structure returned by READDIR(). */
 496 struct dirent {
 497     char        d_name[256];            /* File name            */
 498     int         d_namlen;                       /* Length of d_name */
 499     int         vms_verscount;          /* Number of versions   */
 500     int         vms_versions[20];       /* Version numbers      */
 501 };
 502
 503     /* Handle returned by opendir(), used by the other routines.  You
 504      * are not supposed to care what's inside this structure. */
 505 typedef struct _dirdesc {
 506     long                        context;
 507     int                         vms_wantversions;
 508     unsigned long int           count;
 509     char                        *pattern;
 510     struct dirent               entry;
 511     struct dsc$descriptor_s     pat;
 512 } DIR;
 513
 514 #define rewinddir(dirp)         seekdir((dirp), 0)
 515
 516 /* used for our emulation of getpw* */
 517 struct passwd {
 518         char    *pw_name;    /* Username */
 519         char    *pw_passwd;
 520         Uid_t   pw_uid;      /* UIC member number */
 521         Gid_t   pw_gid;      /* UIC group  number */
 522         char    *pw_comment; /* Default device/directory (Unix-style) */
 523         char    *pw_gecos;   /* Owner */
 524         char    *pw_dir;     /* Default device/directory (VMS-style) */
 525         char    *pw_shell;   /* Default CLI name (eg. DCL) */
 526 };
 527 #define pw_unixdir pw_comment  /* Default device/directory (Unix-style) */
 528 #define getpwnam my_getpwnam
 529 #define getpwuid my_getpwuid
 530 #define getpwent my_getpwent
 531 #define endpwent my_endpwent
 532 #define setpwent my_endpwent
 533
 534 /* Our own stat_t substitute, since we play with st_dev and st_ino -
 535  * we want atomic types so Unix-bound code which compares these fields
 536  * for two files will work most of the time under VMS.
 537  * N.B. 1. The st_ino hack assumes that sizeof(unsigned short[3]) ==
 538  * sizeof(unsigned) + sizeof(unsigned short).  We can't use a union type
 539  * to map the unsigned int we want and the unsigned short[3] the CRTL
 540  * returns into the same member, since gcc has different ideas than DECC
 541  * and VAXC about sizing union types.
 542  * N.B 2. The routine cando() in vms.c assumes that &stat.st_ino is the
 543  * address of a FID.
 544  */
 545 /* First, grab the system types, so we don't clobber them later */
 546 #include <stat.h>
 547 /* Since we've got to match the size of the CRTL's stat_t, we need
 548  * to mimic DECC's alignment settings.
 549  */
 550 #if defined(__DECC) || defined(__DECCXX)
 551 #  pragma __member_alignment __save
 552 #  pragma __nomember_alignment
 553 #endif
 554 #if defined(__DECC)
 555 #  pragma __message __save
 556 #  pragma __message disable (__MISALGNDSTRCT)
 557 #  pragma __message disable (__MISALGNDMEM)
 558 #endif
 559 struct mystat
 560 {
 561         char *st_devnam;  /* pointer to device name */
 562         unsigned st_ino;    /* hack - CRTL uses unsigned short[3] for */
 563         unsigned short rvn; /* FID (num,seq,rvn) */
 564         unsigned short st_mode; /* file "mode" i.e. prot, dir, reg, etc. */
 565         int     st_nlink;       /* for compatibility - not really used */
 566         unsigned st_uid;        /* from ACP - QIO uic field */
 567         unsigned short st_gid;  /* group number extracted from st_uid */
 568         dev_t   st_rdev;        /* for compatibility - always zero */
 569         off_t   st_size;        /* file size in bytes */
 570         unsigned st_atime;      /* file access time; always same as st_mtime */
 571         unsigned st_mtime;      /* last modification time */
 572         unsigned st_ctime;      /* file creation time */
 573         char    st_fab_rfm;     /* record format */
 574         char    st_fab_rat;     /* record attributes */
 575         char    st_fab_fsz;     /* fixed header size */
 576         unsigned st_dev;        /* encoded device name */
 577         /* Pad struct out to integral number of longwords, since DECC 5.6/VAX
 578          * has a bug in dealing with offsets in structs in which are embedded
 579          * other structs whose size is an odd number of bytes.  (An even
 580          * number of bytes is enough to make it happy, but we go for natural
 581          * alignment anyhow.)
 582          */
 583         char    st_fill1[sizeof(void *) - (3*sizeof(unsigned short) + 3*sizeof(char))%sizeof(void *)];
 584 };
 585 typedef unsigned mydev_t;
 586 typedef unsigned myino_t;
 587
 588 /*
 589  * DEC C previous to 6.0 corrupts the behavior of the /prefix
 590  * qualifier with the extern prefix pragma.  This provisional
 591  * hack circumvents this prefix pragma problem in previous
 592  * precompilers.
 593  */
 594 #if defined(__VMS_VER) && __VMS_VER >= 70000000
 595 #  if defined(VMS_WE_ARE_CASE_SENSITIVE) && (__DECC_VER < 60000000)
 596 #    pragma __extern_prefix save
 597 #    pragma __extern_prefix ""  /* set to empty to prevent prefixing */
 598 #    define geteuid decc$__unix_geteuid
 599 #    define getuid decc$__unix_getuid
 600 #    define stat(__p1,__p2)   decc$__utc_stat(__p1,__p2)
 601 #    define fstat(__p1,__p2)  decc$__utc_fstat(__p1,__p2)
 602 #    pragma __extern_prefix restore
 603 #  endif
 604 #endif
 605
 606 #ifndef DONT_MASK_RTL_CALLS  /* defined for vms.c so we can see RTL calls */
 607 #  ifdef stat
 608 #    undef stat
 609 #  endif
 610 #  define stat mystat
 611 #  define dev_t mydev_t
 612 #  define ino_t myino_t
 613 #endif
 614 #if defined(__DECC) || defined(__DECCXX)
 615 #  pragma __member_alignment __restore
 616 #endif
 617 #if defined(__DECC)
 618 #  pragma __message __restore
 619 #endif
 620 /* Cons up a 'delete' bit for testing access */
 621 #define S_IDUSR (S_IWUSR | S_IXUSR)
 622 #define S_IDGRP (S_IWGRP | S_IXGRP)
 623 #define S_IDOTH (S_IWOTH | S_IXOTH)
 624
 625
 626 /* Prototypes for functions unique to vms.c.  Don't include replacements
 627  * for routines in the mainline source files excluded by #ifndef VMS;
 628  * their prototypes are already in proto.h.
 629  *
 630  * In order to keep Gen_ShrFls.Pl happy, functions which are to be made
 631  * available to images linked to PerlShr.Exe must be declared between the
 632  * __VMS_PROTOTYPES__ and __VMS_SEPYTOTORP__ lines, and must be in the form
 633  *    <data type><TAB>name<WHITESPACE>(<prototype args>);
 634  */
 635
 636 #ifdef NO_PERL_TYPEDEFS
 637   /* We don't have Perl typedefs available (e.g. when building a2p), so
 638      we fake them here.  N.B.  There is *no* guarantee that the faked
 639      prototypes will actually match the real routines.  If you want to
 640      call Perl routines, include perl.h to get the real typedefs.  */
 641 #  ifndef bool
 642 #    define bool int
 643 #    define __MY_BOOL_TYPE_FAKE
 644 #  endif
 645 #  ifndef I32
 646 #    define I32  int
 647 #    define __MY_I32_TYPE_FAKE
 648 #  endif
 649 #  ifndef SV
 650 #    define SV   void   /* Since we only see SV * in prototypes */
 651 #    define __MY_SV_TYPE_FAKE
 652 #  endif
 653 #endif
 654
 655 void    prime_env_iter (void);
 656 void    init_os_extras ();
 657 /* prototype section start marker; `typedef' passes through cpp */
 658 typedef char  __VMS_PROTOTYPES__;
 659 #if !defined(PERL_IMPLICIT_CONTEXT)
 660 char *  Perl_my_getenv (const char *, bool);
 661 int     Perl_vmstrnenv (const char *, char *, unsigned long int, struct dsc$descriptor_s **, unsigned long int);
 662 int     Perl_my_trnlnm (const char *, char *, unsigned long int);
 663 char *  Perl_tounixspec (char *, char *);
 664 char *  Perl_tounixspec_ts (char *, char *);
 665 char *  Perl_tovmsspec (char *, char *);
 666 char *  Perl_tovmsspec_ts (char *, char *);
 667 char *  Perl_tounixpath (char *, char *);
 668 char *  Perl_tounixpath_ts (char *, char *);
 669 char *  Perl_tovmspath (char *, char *);
 670 char *  Perl_tovmspath_ts (char *, char *);
 671 int     Perl_do_rmdir (char *);
 672 char *  Perl_fileify_dirspec (char *, char *);
 673 char *  Perl_fileify_dirspec_ts (char *, char *);
 674 char *  Perl_pathify_dirspec (char *, char *);
 675 char *  Perl_pathify_dirspec_ts (char *, char *);
 676 char *  Perl_rmsexpand (char *, char *, char *, unsigned);
 677 char *  Perl_rmsexpand_ts (char *, char *, char *, unsigned);
 678 int     Perl_trim_unixpath (char *, char*, int);
 679 DIR *   Perl_opendir (char *);
 680 int     Perl_rmscopy (char *, char *, int);
 681 #else
 682 int     Perl_vmstrnenv (pTHX_ const char *, char *, unsigned long int, struct dsc$descriptor_s **, unsigned long int);
 683 char *  Perl_my_getenv (pTHX_ const char *, bool);
 684 int     Perl_my_trnlnm (pTHX_ const char *, char *, unsigned long int);
 685 char *  Perl_tounixspec (pTHX_ char *, char *);
 686 char *  Perl_tounixspec_ts (pTHX_ char *, char *);
 687 char *  Perl_tovmsspec (pTHX_ char *, char *);
 688 char *  Perl_tovmsspec_ts (pTHX_ char *, char *);
 689 char *  Perl_tounixpath (pTHX_ char *, char *);
 690 char *  Perl_tounixpath_ts (pTHX_ char *, char *);
 691 char *  Perl_tovmspath (pTHX_ char *, char *);
 692 char *  Perl_tovmspath_ts (pTHX_ char *, char *);
 693 int     Perl_do_rmdir (pTHX_ char *);
 694 char *  Perl_fileify_dirspec (pTHX_ char *, char *);
 695 char *  Perl_fileify_dirspec_ts (pTHX_ char *, char *);
 696 char *  Perl_pathify_dirspec (pTHX_ char *, char *);
 697 char *  Perl_pathify_dirspec_ts (pTHX_ char *, char *);
 698 char *  Perl_rmsexpand (pTHX_ char *, char *, char *, unsigned);
 699 char *  Perl_rmsexpand_ts (pTHX_ char *, char *, char *, unsigned);
 700 int     Perl_trim_unixpath (pTHX_ char *, char*, int);
 701 DIR *   Perl_opendir (pTHX_ char *);
 702 int     Perl_rmscopy (pTHX_ char *, char *, int);
 703 #endif
 704 char *  my_getenv_len (const char *, unsigned long *, bool);
 705 int     vmssetenv (char *, char *, struct dsc$descriptor_s **);
 706 char *  my_crypt (const char *, const char *);
 707 Pid_t   my_waitpid (Pid_t, int *, int);
 708 char *  my_gconvert (double, int, int, char *);
 709 int     kill_file (char *);
 710 int     my_mkdir (char *, Mode_t);
 711 int     my_chdir (char *);
 712 FILE *  my_tmpfile (void);
 713 int     my_utime (char *, struct utimbuf *);
 714 void    vms_image_init (int *, char ***);
 715 struct dirent * readdir (DIR *);
 716 long    telldir (DIR *);
 717 void    seekdir (DIR *, long);
 718 void    closedir (DIR *);
 719 void    vmsreaddirversions (DIR *, int);
 720 struct tm *     my_gmtime (const time_t *);
 721 struct tm *     my_localtime (const time_t *);
 722 time_t  my_time (time_t *);
 723 #ifdef HOMEGROWN_POSIX_SIGNALS
 724 int     my_sigemptyset (sigset_t *);
 725 int     my_sigfillset  (sigset_t *);
 726 int     my_sigaddset   (sigset_t *, int);
 727 int     my_sigdelset   (sigset_t *, int);
 728 int     my_sigismember (sigset_t *, int);
 729 int     my_sigprocmask (int, sigset_t *, sigset_t *);
 730 #endif
 731 I32     cando_by_name (I32, Uid_t, char *);
 732 int     flex_fstat (int, Stat_t *);
 733 int     flex_stat (const char *, Stat_t *);
 734 int     my_vfork ();
 735 bool    vms_do_aexec (SV *, SV **, SV **);
 736 bool    vms_do_exec (char *);
 737 unsigned long int       do_aspawn (void *, void **, void **);
 738 unsigned long int       do_spawn (char *);
 739 int     my_fwrite (void *, size_t, size_t, FILE *);
 740 int     my_flush (FILE *);
 741 struct passwd * my_getpwnam (char *name);
 742 struct passwd * my_getpwuid (Uid_t uid);
 743 struct passwd * my_getpwent ();
 744 void    my_endpwent ();
 745 char *  my_getlogin ();
 746 typedef char __VMS_SEPYTOTORP__;
 747 /* prototype section end marker; `typedef' passes through cpp */
 748
 749 #ifdef NO_PERL_TYPEDEFS  /* We'll try not to scramble later files */
 750 #  ifdef __MY_BOOL_TYPE_FAKE
 751 #    undef bool
 752 #    undef __MY_BOOL_TYPE_FAKE
 753 #  endif
 754 #  ifdef __MY_I32_TYPE_FAKE
 755 #    undef I32
 756 #    undef __MY_I32_TYPE_FAKE
 757 #  endif
 758 #  ifdef __MY_SV_TYPE_FAKE
 759 #    undef SV
 760 #    undef __MY_SV_TYPE_FAKE
 761 #  endif
 762 #endif
 763
 764 #ifndef VMS_DO_SOCKETS
 765 /* This relies on tricks in perl.h to pick up that these manifest constants
 766  * are undefined and set up conversion routines.  It will then redefine
 767  * these manifest constants, so the actual values will match config.h
 768  */
 769 #undef HAS_HTONS
 770 #undef HAS_NTOHS
 771 #undef HAS_HTONL
 772 #undef HAS_NTOHL
 773 #endif
 774
 775 /* The C RTL manual says to undef the macro for DEC C 5.2 and lower. */
 776 #if defined(fileno) && defined(__DECC_VER) && __DECC_VER < 50300000
 777 #  undef fileno
 778 #endif
 779
 780 #endif  /* __vmsish_h_included */