vms/vmsish.h

   1 /*    vmsish.h
   2  *
   3  *    VMS-specific C header file for perl5.
   4  *
   5  *    Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
   6  *    2002, 2003, 2004, 2005, 2006, 2007 by Charles Bailey and others.
   7  *
   8  *    You may distribute under the terms of either the GNU General Public
   9  *    License or the Artistic License, as specified in the README file.
  10  *
  11  *    Please see Changes*.* or the Perl Repository Browser for revision history.
  12  */
  13
  14 #ifndef __vmsish_h_included
  15 #define __vmsish_h_included
  16
  17 #include <descrip.h> /* for dirent struct definitions */
  18 #include <libdef.h>  /* status codes for various places */
  19 #include <rmsdef.h>  /* at which errno and vaxc$errno are */
  20 #include <ssdef.h>   /* explicitly set in the perl source code */
  21 #include <stsdef.h>  /* bitmasks for exit status testing */
  22
  23 /* Suppress compiler warnings from DECC for VMS-specific extensions:
  24  * ADDRCONSTEXT,NEEDCONSTEXT: initialization of data with non-constant values
  25  *                            (e.g. pointer fields of descriptors)
  26  */
  27 #ifdef __DECC
  28 #  pragma message disable (ADDRCONSTEXT,NEEDCONSTEXT)
  29 #endif
  30 #ifdef __DECCXX
  31 #  pragma message informational (INTSIGNCHANGE,CASTQUALTYP,ASSCOMMEA,NOCTOBUTCONREFM)
  32 #endif
  33
  34 /* DEC's C compilers and gcc use incompatible definitions of _to(upp|low)er() */
  35 #ifdef _toupper
  36 #  undef _toupper
  37 #endif
  38 #define _toupper(c) (((c) < 'a' || (c) > 'z') ? (c) : (c) & ~040)
  39 #ifdef _tolower
  40 #  undef _tolower
  41 #endif
  42 #define _tolower(c) (((c) < 'A' || (c) > 'Z') ? (c) : (c) | 040)
  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) || defined(__DECCXX)
  55 #  include <unistd.h> /* DECC has this; gcc doesn't */
  56 #endif
  57
  58 #ifdef NO_PERL_TYPEDEFS /* a2p; we don't want Perl's special routines */
  59 #  define DONT_MASK_RTL_CALLS
  60 #endif
  61
  62 #include <namdef.h>
  63
  64 /* Set the maximum filespec size here as it is larger for EFS file
  65  * specifications.
  66  */
  67 #ifndef __VAX
  68 #ifndef VMS_MAXRSS
  69 #ifdef NAML$C_MAXRSS
  70 #define VMS_MAXRSS (NAML$C_MAXRSS+1)
  71 #ifndef VMS_LONGNAME_SUPPORT
  72 #define VMS_LONGNAME_SUPPORT 1
  73 #endif /* VMS_LONGNAME_SUPPORT */
  74 #endif /* NAML$C_MAXRSS */
  75 #endif /* VMS_MAXRSS */
  76 #endif
  77
  78 #ifndef VMS_MAXRSS
  79 #define VMS_MAXRSS (NAM$C_MAXRSS + 1)
  80 #endif
  81
  82 #ifndef MAXPATHLEN
  83 #define MAXPATHLEN (VMS_MAXRSS - 1)
  84 #endif
  85
  86
  87 /* Note that we do, in fact, have this */
  88 #define HAS_GETENV_SV
  89 #define HAS_GETENV_LEN
  90
  91
  92 #ifndef PERL_FOR_X2P
  93
  94 #ifndef DONT_MASK_RTL_CALLS
  95 #  ifdef getenv
  96 #    undef getenv
  97 #  endif
  98   /* getenv used for regular logical names */
  99 #  define getenv(v) Perl_my_getenv(aTHX_ v,TRUE)
 100 #endif
 101 #ifdef getenv_len
 102 #  undef getenv_len
 103 #endif
 104 #define getenv_len(v,l) Perl_my_getenv_len(aTHX_ v,l,TRUE)
 105
 106 /* DECC introduces this routine in the RTL as of VMS 7.0; for now,
 107  * we'll use ours, since it gives us the full VMS exit status. */
 108 #define waitpid my_waitpid
 109
 110 /* Don't redeclare standard RTL routines in Perl's header files;
 111  * VMS history or extensions makes some of the formal protoypes
 112  * differ from the common Unix forms.
 113  */
 114 #define DONT_DECLARE_STD 1
 115
 116 /* Our own contribution to PerlShr's global symbols . . . */
 117
 118 #if !defined(PERL_IMPLICIT_CONTEXT)
 119 #define opendir                 Perl_opendir
 120 #define rename                  Perl_rename
 121 #define seekdir                 Perl_seekdir
 122 #define readdir                 Perl_readdir
 123 #define readdir_r               Perl_readdir_r
 124 #else
 125 #define opendir(a)              Perl_opendir(aTHX_ a)
 126 #define rename(a,b)             Perl_rename(aTHX_ a,b)
 127 #define seekdir(a,b)            Perl_seekdir(aTHX_ a,b)
 128 #define readdir(a)              Perl_readdir(aTHX_ a)
 129 #define readdir_r(a,b,c)        Perl_readdir_r(aTHX_ a,b,c)
 130 #endif
 131 #define closedir(a)             Perl_closedir(a)
 132 #define telldir(a)              Perl_telldir(a)
 133 #define vmsreaddirversions(a,b) Perl_vmsreaddirversions(a,b)
 134
 135 #define cando_by_name(a,b,c)            Perl_cando_by_name(aTHX_ a,b,c)
 136 #define do_rmdir(a)                     Perl_do_rmdir(aTHX_ a)
 137 #define fileify_dirspec(a,b)            Perl_fileify_dirspec(aTHX_ a,b)
 138 #define fileify_dirspec(a,b)            Perl_fileify_dirspec(aTHX_ a,b)
 139 #define fileify_dirspec_ts(a,b)         Perl_fileify_dirspec_ts(aTHX_ a,b)
 140 #define fileify_dirspec_ts(a,b)         Perl_fileify_dirspec_ts(aTHX_ a,b)
 141 #define fileify_dirspec_utf8(a,b,c)     Perl_fileify_dirspec(aTHX_ a,b,utf8)
 142 #define fileify_dirspec_utf8_ts(a,b,c)  Perl_fileify_dirspec_ts(aTHX_ a,b,utf8)
 143 #define flex_fstat(a,b)                 Perl_flex_fstat(aTHX_ a,b)
 144 #define flex_lstat(a,b)                 Perl_flex_lstat(aTHX_ a,b)
 145 #define flex_stat(a,b)                  Perl_flex_stat(aTHX_ a,b)
 146 #define init_os_extras                  Perl_init_os_extras
 147 #define kill_file(a)                    Perl_kill_file(aTHX_ a)
 148 #define my_chdir(a)                     Perl_my_chdir(aTHX_ a)
 149 #define my_chmod(a,b)                   Perl_my_chmod(aTHX_ a,b)
 150 #define my_crypt(a,b)                   Perl_my_crypt(aTHX_ a,b)
 151 #define my_endpwent()                   Perl_my_endpwent(aTHX)
 152 #define my_fclose(a)                    Perl_my_fclose(a)
 153 #define my_fdopen(a,b)                  Perl_my_fdopen(a,b)
 154 #define my_flush(a)                     Perl_my_flush(aTHX_ a)
 155 #define my_fwrite(a,b,c,d)              Perl_my_fwrite(a,b,c,d)
 156 #define my_fgetname(a,b)                Perl_my_fgetname(a,b)
 157 #define my_gconvert(a,b,c,d)            Perl_my_gconvert(a,b,c,d)
 158 #define my_getenv(a,b)                  Perl_my_getenv(aTHX_ a,b)
 159 #define my_getenv_len(a,b,c)            Perl_my_getenv_len(aTHX_ a,b,c)
 160 #define my_getlogin                     Perl_my_getlogin
 161 #define my_getpwent()                   Perl_my_getpwent(aTHX)
 162 #define my_getpwnam(a)                  Perl_my_getpwnam(aTHX_ a)
 163 #define my_getpwuid(a)                  Perl_my_getpwuid(aTHX_ a)
 164 #define my_gmtime(a)                    Perl_my_gmtime(aTHX_ a)
 165 #define my_localtime(a)                 Perl_my_localtime(aTHX_ a)
 166 #define my_mkdir(a,b)                   Perl_my_mkdir(aTHX_ a,b)
 167 #define my_sigemptyset(a)               Perl_my_sigemptyset(a)
 168 #define my_sigfillset(a)                Perl_my_sigfillset(a)
 169 #define my_sigaddset(a,b)               Perl_my_sigaddset(a,b)
 170 #define my_sigdelset(a,b,c)             Perl_my_sigdelset(a,b,c)
 171 #define my_sigismember(a,b)             Perl_my_sigismember(a,b)
 172 #define my_sigprocmask(a,b,c)           Perl_my_sigprocmask(a,b,c)
 173 #ifdef HAS_SYMLINK
 174 #  define my_symlink(a,b)               Perl_my_symlink(aTHX_ a,b)
 175 #endif
 176 #define my_time(a)                      Perl_my_time(aTHX_ a)
 177 #define my_tmpfile                      Perl_my_tmpfile
 178 #define my_trnlnm(a,b,c)                Perl_my_trnlnm(aTHX_ a,b,c)
 179 #define my_utime(a,b)                   Perl_my_utime(aTHX_ a,b)
 180 #define my_vfork                        Perl_my_vfork
 181 #define my_waitpid(a,b,c)               Perl_my_waitpid(aTHX_ a,b,c)
 182 #define pathify_dirspec(a,b)            Perl_pathify_dirspec(aTHX a,b)
 183 #define pathify_dirspec_ts(a,b)         Perl_pathify_dirspec_ts(aTHX a,b)
 184 #define pathify_dirspec_utf8(a,b,c)     Perl_pathify_dirspec_utf8(aTHX a,b,c)
 185 #define pathify_dirspec_utf8_ts(a,b,c)  Perl_pathify_dirspec_utf8_ts(aTHX a,b,c)
 186 #define prime_env_iter                  Perl_prime_env_iter
 187 #define rmscopy(a,b,c)                  Perl_rmscopy(aTHX_ a,b,c)
 188 #define rmsexpand(a,b,c,d)              Perl_rmsexpand_utf8(aTHX_ a,b,c,d,NULL,NULL)
 189 #define rmsexpand_ts(a,b,c,d)           Perl_rmsexpand_utf8_ts(aTHX_ a,b,c,d,NULL,NULL)
 190 #define rmsexpand_utf8(a,b,c,d,e,f)     Perl_rmsexpand_utf8(aTHX_ a,b,c,d,e,f)
 191 #define rmsexpand_utf8_ts(a,b,c,d,e,f)  Perl_rmsexpand_utf8_ts(aTHX_ a,b,c,d,e,f)
 192 #define tounixpath(a,b)                 Perl_tounixpath_utf8(aTHX_ a,b,NULL)
 193 #define tounixpath_ts(a,b)              Perl_tounixpath_utf8_ts(aTHX_ a,b,NULL)
 194 #define tounixpath_utf8(a,b,c)          Perl_tounixpath_utf8(aTHX_ a,b,c)
 195 #define tounixpath_utf8_ts(a,b,c)       Perl_tounixpath_utf8_ts(aTHX_ a,b,c)
 196 #define tounixspec(a,b)                 Perl_tounixspec_utf8(aTHX_ a,b,NULL)
 197 #define tounixspec_ts(a,b)              Perl_tounixspec_utf8_ts(aTHX_ a,b,NULL)
 198 #define tounixspec_utf8(a,b,c)          Perl_tounixspec_utf8(aTHX_ a,b,c)
 199 #define tounixspec_utf8_ts(a,b,c)       Perl_tounixspec_utf8_ts(aTHX_ a,b,c)
 200 #define tovmspath(a,b)                  Perl_tovmspath_utf8(aTHX_ a,b,NULL)
 201 #define tovmspath_ts(a,b)               Perl_tovmspath_utf8_ts(aTHX_ a,b,NULL)
 202 #define tovmspath_utf8(a,b,c)           Perl_tovmspath_utf8(aTHX_ a,b,c)
 203 #define tovmspath_utf8_ts(a,b,c)        Perl_tovmspath_utf8_ts(aTHX_ a,b,c)
 204 #define tovmsspec(a,b)                  Perl_tovmsspec_utf8(aTHX_ a,b,NULL)
 205 #define tovmsspec_ts(a,b)               Perl_tovmsspec_utf8_ts(aTHX_ a,b)
 206 #define tovmsspec_utf8(a,b,c)           Perl_tovmsspec_utf8(aTHX_ a,b,c)
 207 #define tovmsspec_utf8_ts(a,b,c)        Perl_tovmsspec_utf8_ts(aTHX_ a,b,c)
 208 #define trim_unixpath(a,b,c)            Perl_trim_unixpath(aTHX_ a,b,c)
 209 #define vms_do_aexec(a,b,c)             Perl_vms_do_aexec(aTHX_ a,b,c)
 210 #define vms_do_exec(a)                  Perl_vms_do_exec(aTHX_ a)
 211 #define vms_case_tolerant(a)            Perl_vms_case_tolerant(a)
 212 #define vms_image_init(a,b)             Perl_vms_image_init(a,b)
 213 #define vms_realname(a,b,c)             Perl_vms_realname(aTHX_ a,b,c)
 214 #define vms_realpath(a,b,c)             Perl_vms_realpath(aTHX_ a,b,c)
 215 #define vmssetenv(a,b,c)                Perl_vmssetenv(aTHX_ a,b,c)
 216 #define vmstrnenv(a,b,c,d,e)            Perl_vmstrnenv(a,b,c,d,e)
 217
 218 /* Delete if at all possible, changing protections if necessary. */
 219 #define unlink(a) kill_file(a)
 220
 221 /*
 222  * Intercept calls to fork, so we know whether subsequent calls to
 223  * exec should be handled in VMSish or Unixish style.
 224  */
 225 #define fork my_vfork
 226 #ifndef DONT_MASK_RTL_CALLS     /* #defined in vms.c so we see real vfork */
 227 #  ifdef vfork
 228 #    undef vfork
 229 #  endif
 230 #  define vfork my_vfork
 231 #endif
 232
 233 /*
 234  * Toss in a shim to tmpfile which creates a plain temp file if the
 235  * RMS tmp mechanism won't work (e.g. if someone is relying on ACLs
 236  * from a specific directory to permit creation of files).
 237  */
 238 #ifndef DONT_MASK_RTL_CALLS
 239 #  define tmpfile Perl_my_tmpfile
 240 #endif
 241 #endif
 242
 243
 244 /* BIG_TIME:
 245  *      This symbol is defined if Time_t is an unsigned type on this system.
 246  */
 247 #define BIG_TIME
 248
 249 /* ACME_MESS:
 250  *      This symbol, if defined, indicates that error messages should be
 251  *      should be generated in a format that allows the use of the Acme
 252  *      GUI/editor's autofind feature.
 253  */
 254 #undef ACME_MESS        /**/
 255
 256 /* ALTERNATE_SHEBANG:
 257  *      This symbol, if defined, contains a "magic" string which may be used
 258  *      as the first line of a Perl program designed to be executed directly
 259  *      by name, instead of the standard Unix #!.  If ALTERNATE_SHEBANG
 260  *      begins with a character other then #, then Perl will only treat
 261  *      it as a command line if if finds the string "perl" in the first
 262  *      word; otherwise it's treated as the first line of code in the script.
 263  *      (IOW, Perl won't hand off to another interpreter via an alternate
 264  *      shebang sequence that might be legal Perl code.)
 265  */
 266 #define ALTERNATE_SHEBANG "$"
 267
 268 /* Macros to set errno using the VAX thread-safe calls, if present */
 269 #if (defined(__DECC) || defined(__DECCXX)) && !defined(__ALPHA)
 270 #  define set_errno(v)      (cma$tis_errno_set_value(v))
 271    void cma$tis_errno_set_value(int __value);  /* missing in some errno.h */
 272 #  define set_vaxc_errno(v) (vaxc$errno = (v))
 273 #else
 274 #  define set_errno(v)      (errno = (v))
 275 #  define set_vaxc_errno(v) (vaxc$errno = (v))
 276 #endif
 277
 278 /* Support for 'vmsish' behaviors enabled with C<use vmsish> pragma */
 279
 280 #define COMPLEX_STATUS  1       /* We track both "POSIX" and VMS values */
 281
 282 #define HINT_V_VMSISH           24
 283 #define HINT_M_VMSISH_STATUS    0x40000000 /* system, $? return VMS status */
 284 #define HINT_M_VMSISH_TIME      0x80000000 /* times are local, not UTC */
 285 #define NATIVE_HINTS            (PL_hints >> HINT_V_VMSISH)  /* used in op.c */
 286
 287 #ifdef PERL_IMPLICIT_CONTEXT
 288 #  define TEST_VMSISH(h)        (my_perl && PL_curcop && (PL_curcop->op_private & ((h) >> HINT_V_VMSISH)))
 289 #else
 290 #  define TEST_VMSISH(h)        (PL_curcop && (PL_curcop->op_private & ((h) >> HINT_V_VMSISH)))
 291 #endif
 292 #define VMSISH_STATUS   TEST_VMSISH(HINT_M_VMSISH_STATUS)
 293 #define VMSISH_TIME     TEST_VMSISH(HINT_M_VMSISH_TIME)
 294
 295 /* VMS-specific data storage */
 296
 297 #define HAVE_INTERP_INTERN
 298 struct interp_intern {
 299     int    hushed;
 300     int    posix_exit;
 301     double inv_rand_max;
 302 };
 303 #define VMSISH_HUSHED     (PL_sys_intern.hushed)
 304 #define MY_INV_RAND_MAX   (PL_sys_intern.inv_rand_max)
 305 #define MY_POSIX_EXIT   (PL_sys_intern.posix_exit)
 306
 307 /* Flags for vmstrnenv() */
 308 #define PERL__TRNENV_SECURE 0x01
 309 #define PERL__TRNENV_JOIN_SEARCHLIST 0x02
 310
 311 /* Handy way to vet calls to VMS system services and RTL routines. */
 312 #define _ckvmssts(call) STMT_START { register unsigned long int __ckvms_sts; \
 313   if (!((__ckvms_sts=(call))&1)) { \
 314   set_errno(EVMSERR); set_vaxc_errno(__ckvms_sts); \
 315   Perl_croak(aTHX_ "Fatal VMS error (status=%d) at %s, line %d", \
 316   __ckvms_sts,__FILE__,__LINE__); } } STMT_END
 317
 318 /* Same thing, but don't call back to Perl's croak(); useful for errors
 319  * occurring during startup, before Perl's state is initialized */
 320 #define _ckvmssts_noperl(call) STMT_START { register unsigned long int __ckvms_sts; \
 321   if (!((__ckvms_sts=(call))&1)) { \
 322   set_errno(EVMSERR); set_vaxc_errno(__ckvms_sts); \
 323   fprintf(stderr,"Fatal VMS error (status=%d) at %s, line %d", \
 324   __ckvms_sts,__FILE__,__LINE__); lib$signal(__ckvms_sts); } } STMT_END
 325
 326 #ifdef VMS_DO_SOCKETS
 327 #define PERL_SOCK_SYSREAD_IS_RECV
 328 #define PERL_SOCK_SYSWRITE_IS_SEND
 329 #endif
 330
 331 #define BIT_BUCKET "/dev/null"
 332 #define PERL_SYS_INIT_BODY(c,v) MALLOC_CHECK_TAINT2(*c,*v) vms_image_init((c),(v)); PERLIO_INIT; MALLOC_INIT
 333 #define PERL_SYS_TERM_BODY()            HINTS_REFCNT_TERM; OP_REFCNT_TERM; PERLIO_TERM; MALLOC_TERM
 334 #define dXSUB_SYS
 335 #define HAS_KILL
 336 #define HAS_WAIT
 337
 338 #ifndef PERL_CORE
 339 #  define PERL_FS_VER_FMT       "%d_%d_%d"
 340 #endif
 341 #define PERL_FS_VERSION         STRINGIFY(PERL_REVISION) "_" \
 342                                 STRINGIFY(PERL_VERSION) "_" \
 343                                 STRINGIFY(PERL_SUBVERSION)
 344 /* Temporary; we need to add support for this to Configure.Com */
 345 #ifdef PERL_INC_VERSION_LIST
 346 #  undef PERL_INC_VERSION_LIST
 347 #endif
 348
 349 /* VMS:
 350  *      This symbol, if defined, indicates that the program is running under
 351  *      VMS.  It's a symbol automagically defined by all VMS C compilers I've seen.
 352  * Just in case, however . . . */
 353 /* Note that code really should be using __VMS to comply with ANSI */
 354 #ifndef VMS
 355 #define VMS             /**/
 356 #endif
 357
 358 /* HAS_IOCTL:
 359  *      This symbol, if defined, indicates that the ioctl() routine is
 360  *      available to set I/O characteristics
 361  */
 362 #define HAS_IOCTL               /**/
 363
 364 /* HAS_UTIME:
 365  *      This symbol, if defined, indicates that the routine utime() is
 366  *      available to update the access and modification times of files.
 367  */
 368 #define HAS_UTIME               /**/
 369
 370 /* HAS_GROUP
 371  *      This symbol, if defined, indicates that the getgrnam() and
 372  *      getgrgid() routines are available to get group entries.
 373  *      The getgrent() has a separate definition, HAS_GETGRENT.
 374  */
 375 #if __CRTL_VER >= 70302000
 376 #define HAS_GROUP               /**/
 377 #else
 378 #undef HAS_GROUP                /**/
 379 #endif
 380
 381 /* HAS_PASSWD
 382  *      This symbol, if defined, indicates that the getpwnam() and
 383  *      getpwuid() routines are available to get password entries.
 384  *      The getpwent() has a separate definition, HAS_GETPWENT.
 385  */
 386 #define HAS_PASSWD              /**/
 387
 388 #define HAS_KILL
 389 #define HAS_WAIT
 390
 391 /* USEMYBINMODE
 392  *      This symbol, if defined, indicates that the program should
 393  *      use the routine my_binmode(FILE *fp, char iotype, int mode) to insure
 394  *      that a file is in "binary" mode -- that is, that no translation
 395  *      of bytes occurs on read or write operations.
 396  */
 397 #undef USEMYBINMODE
 398
 399 /* Stat_t:
 400  *      This symbol holds the type used to declare buffers for information
 401  *      returned by stat().  It's usually just struct stat.  It may be necessary
 402  *      to include <sys/stat.h> and <sys/types.h> to get any typedef'ed
 403  *      information.
 404  */
 405 /* VMS:
 406  * We need this typedef to point to the new type even if DONT_MASK_RTL_CALLS
 407  * is in effect, since Perl's thread.h embeds one of these structs in its
 408  * thread data struct, and our struct mystat is a different size from the
 409  * regular struct stat (cf. note above about having to pad struct to work
 410  * around bug in compiler.)
 411  * It's OK to pass one of these to the RTL's stat(), though, since the
 412  * fields it fills are the same in each struct.
 413  */
 414 #define Stat_t struct mystat
 415
 416 /* USE_STAT_RDEV:
 417 *       This symbol is defined if this system has a stat structure declaring
 418 *       st_rdev
 419 *       VMS: Field exists in POSIXish version of struct stat(), but is not used.
 420 *
 421 *  No definition of what value an operating system or file system should
 422 *  put in the st_rdev field has been found by me so far.  Examination of
 423 *  LINUX source code indicates that the value is both very platform and
 424 *  file system specific, with many filesystems just putting 1 or 0 in it.
 425 *  J. Malmberg.
 426 */
 427 #undef USE_STAT_RDEV            /**/
 428
 429 /*
 430  * fwrite1() should be a routine with the same calling sequence as fwrite(),
 431  * but which outputs all of the bytes requested as a single stream (unlike
 432  * fwrite() itself, which on some systems outputs several distinct records
 433  * if the number_of_items parameter is >1).
 434  */
 435 #define fwrite1 my_fwrite
 436
 437
 438 #ifndef DONT_MASK_RTL_CALLS
 439 #  define fwrite my_fwrite     /* for PerlSIO_fwrite */
 440 #  define fdopen my_fdopen
 441 #  define fclose my_fclose
 442 #  define fgetname(a, b) my_fgetname(a, b)
 443 #ifdef HAS_SYMLINK
 444 #  define symlink my_symlink
 445 #endif
 446 #endif
 447
 448
 449 /* By default, flush data all the way to disk, not just to RMS buffers */
 450 #define Fflush(fp) my_flush(fp)
 451
 452 /* Use our own rmdir() */
 453 #ifndef DONT_MASK_RTL_CALLS
 454 #define rmdir(name) do_rmdir(name)
 455 #endif
 456
 457 /* Assorted fiddling with sigs . . . */
 458 # include <signal.h>
 459 #define ABORT() abort()
 460
 461 #ifdef I_UTIME
 462 #include <utime.h>
 463 #else
 464 /* Used with our my_utime() routine in vms.c */
 465 struct utimbuf {
 466   time_t actime;
 467   time_t modtime;
 468 };
 469 #endif
 470 #ifndef DONT_MASK_RTL_CALLS
 471 #define utime my_utime
 472 #endif
 473
 474 /* This is what times() returns, but <times.h> calls it tbuffer_t on VMS
 475  * prior to v7.0.  We check the DECC manifest to see whether it's already
 476  * done this for us, relying on the fact that perl.h #includes <time.h>
 477  * before it #includes "vmsish.h".
 478  */
 479
 480 #ifndef __TMS
 481   struct tms {
 482     clock_t tms_utime;    /* user time */
 483     clock_t tms_stime;    /* system time - always 0 on VMS */
 484     clock_t tms_cutime;   /* user time, children */
 485     clock_t tms_cstime;   /* system time, children - always 0 on VMS */
 486   };
 487 #else
 488    /* The new headers change the times() prototype to tms from tbuffer */
 489 #  define tbuffer_t struct tms
 490 #endif
 491
 492 /* Substitute our own routines for gmtime(), localtime(), and time(),
 493  * which allow us to implement the vmsish 'time' pragma, and work
 494  * around absence of system-level UTC support on old versions of VMS.
 495  */
 496 #define gmtime(t) my_gmtime(t)
 497 #define localtime(t) my_localtime(t)
 498 #define time(t) my_time(t)
 499
 500 /*
 501  * The C RTL's sigaction fails to check for invalid signal numbers so we
 502  * help it out a bit.
 503  */
 504 #ifndef DONT_MASK_RTL_CALLS
 505 #    define sigaction(a,b,c) Perl_my_sigaction(aTHX_ a,b,c)
 506 #endif
 507 #ifdef KILL_BY_SIGPRC
 508 #  define kill  Perl_my_kill
 509 #endif
 510
 511
 512 /* VMS doesn't use a real sys_nerr, but we need this when scanning for error
 513  * messages in text strings . . .
 514  */
 515
 516 #define sys_nerr EVMSERR  /* EVMSERR is as high as we can go. */
 517
 518 /* Look up new %ENV values on the fly */
 519 #define DYNAMIC_ENV_FETCH 1
 520   /* Special getenv function for retrieving %ENV elements. */
 521 #define ENVgetenv(v) my_getenv(v,FALSE)
 522 #define ENVgetenv_len(v,l) my_getenv_len(v,l,FALSE)
 523
 524
 525 /* Thin jacket around cuserid() to match Unix' calling sequence */
 526 #define getlogin my_getlogin
 527
 528 /* Ditto for sys$hash_password() . . . */
 529 #define crypt(a,b)  Perl_my_crypt(aTHX_ a,b)
 530
 531 /* Tweak arg to mkdir & chdir first, so we can tolerate trailing /. */
 532 #define Mkdir(dir,mode) Perl_my_mkdir(aTHX_ (dir),(mode))
 533 #define Chdir(dir) my_chdir((dir))
 534 #ifndef DONT_MASK_RTL_CALLS
 535 #define chmod(file_spec, mode) my_chmod((file_spec), (mode))
 536 #endif
 537
 538 /* Use our own stat() clones, which handle Unix-style directory names */
 539 #define Stat(name,bufptr) flex_stat(name,bufptr)
 540 #define Fstat(fd,bufptr) Perl_flex_fstat(aTHX_ fd,bufptr)
 541 #ifndef DONT_MASK_RTL_CALLS
 542 #define lstat(name, bufptr) flex_lstat(name, bufptr)
 543 #endif
 544
 545 /* Setup for the dirent routines:
 546  * opendir(), closedir(), readdir(), seekdir(), telldir(), and
 547  * vmsreaddirversions(), and preprocessor stuff on which these depend:
 548  *    Written by Rich $alz, <rsalz@bbn.com> in August, 1990.
 549  *
 550  */
 551
 552 /* Flags for the _dirdesc structure */
 553 #define PERL_VMSDIR_M_VERSIONS          0x02 /* Want VMS versions */
 554 #define PERL_VMSDIR_M_UNIXSPECS         0x04 /* Want UNIX specifications */
 555
 556
 557     /* Data structure returned by READDIR(). */
 558 struct dirent {
 559     char        d_name[256];            /* File name            */
 560     int         d_namlen;               /* Length of d_name */
 561     int         vms_verscount;          /* Number of versions   */
 562     int         vms_versions[20];       /* Version numbers      */
 563 };
 564
 565     /* Handle returned by opendir(), used by the other routines.  You
 566      * are not supposed to care what's inside this structure. */
 567 typedef struct _dirdesc {
 568     long                        context;
 569     int                         flags;
 570     unsigned long int           count;
 571     char                        *pattern;
 572     struct dirent               entry;
 573     struct dsc$descriptor_s     pat;
 574     void                        *mutex;
 575 } DIR;
 576
 577
 578 #define rewinddir(dirp)         seekdir((dirp), 0)
 579
 580 /* used for our emulation of getpw* */
 581 struct passwd {
 582         char    *pw_name;    /* Username */
 583         char    *pw_passwd;
 584         Uid_t   pw_uid;      /* UIC member number */
 585         Gid_t   pw_gid;      /* UIC group  number */
 586         char    *pw_comment; /* Default device/directory (Unix-style) */
 587         char    *pw_gecos;   /* Owner */
 588         char    *pw_dir;     /* Default device/directory (VMS-style) */
 589         char    *pw_shell;   /* Default CLI name (eg. DCL) */
 590 };
 591 #define pw_unixdir pw_comment  /* Default device/directory (Unix-style) */
 592 #define getpwnam my_getpwnam
 593 #define getpwuid my_getpwuid
 594 #define getpwent my_getpwent
 595 #define endpwent my_endpwent
 596 #define setpwent my_endpwent
 597
 598 /* Our own stat_t substitute, since we play with st_dev and st_ino -
 599  * we want atomic types so Unix-bound code which compares these fields
 600  * for two files will work most of the time under VMS.
 601  * N.B. 1. The st_ino hack assumes that sizeof(unsigned short[3]) ==
 602  * sizeof(unsigned) + sizeof(unsigned short).  We can't use a union type
 603  * to map the unsigned int we want and the unsigned short[3] the CRTL
 604  * returns into the same member, since gcc has different ideas than DECC
 605  * and VAXC about sizing union types.
 606  * N.B. 2. The routine cando() in vms.c assumes that &stat.st_ino is the
 607  * address of a FID.
 608  */
 609 /* First, grab the system types, so we don't clobber them later */
 610 #include <stat.h>
 611 /* Since we've got to match the size of the CRTL's stat_t, we need
 612  * to mimic DECC's alignment settings.
 613  *
 614  * The simplest thing is to just put a wrapper around the stat structure
 615  * supplied by the CRTL and use #defines to redirect references to the
 616  * members to the real names.
 617  */
 618
 619 #if defined(__DECC) || defined(__DECCXX)
 620 #  pragma __member_alignment __save
 621 #  pragma member_alignment
 622 #endif
 623
 624 typedef unsigned mydev_t;
 625 #ifndef _LARGEFILE
 626 typedef unsigned myino_t;
 627 #else
 628 typedef __ino64_t myino_t;
 629 #endif
 630
 631 struct mystat
 632 {
 633     struct stat crtl_stat;
 634     myino_t st_ino;
 635 #ifndef _LARGEFILE
 636     unsigned rvn; /* FID (num,seq,rvn) + pad */
 637 #endif
 638     mydev_t st_dev;
 639     char st_devnam[256]; /* Cache the (short) VMS name */
 640 };
 641
 642 #define st_mode crtl_stat.st_mode
 643 #define st_nlink crtl_stat.st_nlink
 644 #define st_uid crtl_stat.st_uid
 645 #define st_gid crtl_stat.st_gid
 646 #define st_rdev crtl_stat.st_rdev
 647 #define st_size crtl_stat.st_size
 648 #define st_atime crtl_stat.st_atime
 649 #define st_mtime crtl_stat.st_mtime
 650 #define st_ctime crtl_stat.st_ctime
 651 #define st_fab_rfm crtl_stat.st_fab_rfm
 652 #define st_fab_rat crtl_stat.st_fab_rat
 653 #define st_fab_fsz crtl_stat.st_fab_fsz
 654 #define st_fab_mrs crtl_stat.st_fab_mrs
 655
 656 #ifdef _USE_STD_STAT
 657 #define VMS_INO_T_COMPARE(__a, __b) (__a != __b)
 658 #define VMS_INO_T_COPY(__a, __b) __a = __b
 659 #else
 660 #define VMS_INO_T_COMPARE(__a, __b) memcmp(&__a, &__b, 6)
 661 #define VMS_INO_T_COPY(__a, __b) memcpy(&__a, &__b, 6)
 662 #endif
 663
 664 #if defined(__DECC) || defined(__DECCXX)
 665 #  pragma __member_alignment __restore
 666 #endif
 667
 668 #ifndef DONT_MASK_RTL_CALLS  /* defined for vms.c so we can see RTL calls */
 669 #  ifdef stat
 670 #    undef stat
 671 #  endif
 672 #  define stat mystat
 673 #  define dev_t mydev_t
 674 #  define ino_t myino_t
 675 #endif
 676 /* Cons up a 'delete' bit for testing access */
 677 #define S_IDUSR (S_IWUSR | S_IXUSR)
 678 #define S_IDGRP (S_IWGRP | S_IXGRP)
 679 #define S_IDOTH (S_IWOTH | S_IXOTH)
 680
 681
 682 #ifndef PERL_FOR_X2P
 683 /* Prototypes for functions unique to vms.c.  Don't include replacements
 684  * for routines in the mainline source files excluded by #ifndef VMS;
 685  * their prototypes are already in proto.h.
 686  */
 687
 688 #ifdef __cplusplus
 689 extern "C" {
 690 #endif
 691
 692 void    prime_env_iter (void);
 693 void    init_os_extras (void);
 694 int     Perl_vms_status_to_unix(int vms_status, int child_flag);
 695 int     Perl_unix_status_to_vms(int unix_status);
 696 int     Perl_vmstrnenv (const char *, char *, unsigned long int, struct dsc$descriptor_s **, unsigned long int);
 697 char *  Perl_vms_realpath (pTHX_ const char *, char *, int *);
 698 char *  Perl_my_getenv (pTHX_ const char *, bool);
 699 int     Perl_my_trnlnm (pTHX_ const char *, char *, unsigned long int);
 700 char *  Perl_tounixspec (pTHX_ const char *, char *);
 701 char *  Perl_tounixspec_ts (pTHX_ const char *, char *);
 702 char *  Perl_tounixspec_utf8 (pTHX_ const char *, char *, int *);
 703 char *  Perl_tounixspec_utf8_ts (pTHX_ const char *, char *, int *);
 704 char *  Perl_tovmsspec (pTHX_ const char *, char *);
 705 char *  Perl_tovmsspec_ts (pTHX_ const char *, char *);
 706 char *  Perl_tovmsspec_utf8 (pTHX_ const char *, char *, int *);
 707 char *  Perl_tovmsspec_utf8_ts (pTHX_ const char *, char *, int *);
 708 char *  Perl_tounixpath (pTHX_ const char *, char *);
 709 char *  Perl_tounixpath_ts (pTHX_ const char *, char *);
 710 char *  Perl_tounixpath_utf8 (pTHX_ const char *, char *, int *);
 711 char *  Perl_tounixpath_utf8_ts (pTHX_ const char *, char *, int *);
 712 char *  Perl_tovmspath (pTHX_ const char *, char *);
 713 char *  Perl_tovmspath_ts (pTHX_ const char *, char *);
 714 char *  Perl_tovmspath_utf8 (pTHX_ const char *, char *, int *);
 715 char *  Perl_tovmspath_utf8_ts (pTHX_ const char *, char *, int *);
 716 int     Perl_do_rmdir (pTHX_ const char *);
 717 char *  Perl_fileify_dirspec (pTHX_ const char *, char *);
 718 char *  Perl_fileify_dirspec_ts (pTHX_ const char *, char *);
 719 char *  Perl_fileify_dirspec_utf8 (pTHX_ const char *, char *, int *);
 720 char *  Perl_fileify_dirspec_utf8_ts (pTHX_ const char *, char *, int *);
 721 char *  Perl_pathify_dirspec (pTHX_ const char *, char *);
 722 char *  Perl_pathify_dirspec_ts (pTHX_ const char *, char *);
 723 char *  Perl_pathify_dirspec_utf8 (pTHX_ const char *, char *, int *);
 724 char *  Perl_pathify_dirspec_utf8_ts (pTHX_ const char *, char *, int *);
 725 char *  Perl_rmsexpand (pTHX_ const char *, char *, const char *, unsigned);
 726 char *  Perl_rmsexpand_ts (pTHX_ const char *, char *, const char *, unsigned);
 727 char *  Perl_rmsexpand_utf8 (pTHX_ const char *, char *, const char *, unsigned, int *, int *);
 728 char *  Perl_rmsexpand_utf8_ts (pTHX_ const char *, char *, const char *, unsigned, int *, int *);
 729 int     Perl_trim_unixpath (pTHX_ char *, const char*, int);
 730 DIR * Perl_opendir (pTHX_ const char *);
 731 int     Perl_rename (pTHX_ const char *, const char *);
 732 int     Perl_rmscopy (pTHX_ const char *, const char *, int);
 733 int     Perl_my_mkdir (pTHX_ const char *, Mode_t);
 734 bool    Perl_vms_do_aexec (pTHX_ SV *, SV **, SV **);
 735 int     Perl_vms_case_tolerant(void);
 736 char *  Perl_my_getenv_len (pTHX_ const char *, unsigned long *, bool);
 737 int     Perl_vmssetenv (pTHX_ const char *, const char *, struct dsc$descriptor_s **);
 738 void    Perl_vmssetuserlnm(pTHX_ const char *name, const char *eqv);
 739 char *  Perl_my_crypt (pTHX_ const char *, const char *);
 740 Pid_t   Perl_my_waitpid (pTHX_ Pid_t, int *, int);
 741 char *  my_gconvert (double, int, int, char *);
 742 int     Perl_kill_file (pTHX_ const char *);
 743 int     Perl_my_chdir (pTHX_ const char *);
 744 int     Perl_my_chmod(pTHX_ const char *, mode_t);
 745 FILE *  Perl_my_tmpfile (void);
 746 int     Perl_my_sigaction (pTHX_ int, const struct sigaction*, struct sigaction*);
 747 #ifdef KILL_BY_SIGPRC
 748 unsigned int    Perl_sig_to_vmscondition (int);
 749 int     Perl_my_kill (int, int);
 750 void    Perl_csighandler_init (void);
 751 #endif
 752 int     Perl_my_utime (pTHX_ const char *, const struct utimbuf *);
 753 void    Perl_vms_image_init (int *, char ***);
 754 struct dirent * Perl_readdir (pTHX_ DIR *);
 755 int     Perl_readdir_r(pTHX_ DIR *, struct dirent *, struct dirent **);
 756 long    Perl_telldir (DIR *);
 757 void    Perl_seekdir (pTHX_ DIR *, long);
 758 void    Perl_closedir (DIR *);
 759 void    vmsreaddirversions (DIR *, int);
 760 struct tm *     Perl_my_gmtime (pTHX_ const time_t *);
 761 struct tm *     Perl_my_localtime (pTHX_ const time_t *);
 762 time_t  Perl_my_time (pTHX_ time_t *);
 763 I32     Perl_cando_by_name (pTHX_ I32, bool, const char *);
 764 int     Perl_flex_fstat (pTHX_ int, Stat_t *);
 765 int     Perl_flex_lstat (pTHX_ const char *, Stat_t *);
 766 int     Perl_flex_stat (pTHX_ const char *, Stat_t *);
 767 int     my_vfork (void);
 768 bool    Perl_vms_do_exec (pTHX_ const char *);
 769 FILE *  my_fdopen (int, const char *);
 770 int     my_fclose (FILE *);
 771 int     my_fwrite (const void *, size_t, size_t, FILE *);
 772 char *  Perl_my_fgetname (FILE *fp, char *buf);
 773 #ifdef HAS_SYMLINK
 774 int     Perl_my_symlink(pTHX_ const char *path1, const char *path2);
 775 #endif
 776 int     Perl_my_flush (pTHX_ FILE *);
 777 struct passwd * Perl_my_getpwnam (pTHX_ const char *name);
 778 struct passwd * Perl_my_getpwuid (pTHX_ Uid_t uid);
 779 void    Perl_my_endpwent (pTHX);
 780 char *  my_getlogin (void);
 781
 782 #ifdef __cplusplus
 783 }
 784 #endif
 785
 786 #endif
 787
 788 #ifndef VMS_DO_SOCKETS
 789 /* This relies on tricks in perl.h to pick up that these manifest constants
 790  * are undefined and set up conversion routines.  It will then redefine
 791  * these manifest constants, so the actual values will match config.h
 792  */
 793 #undef HAS_HTONS
 794 #undef HAS_NTOHS
 795 #undef HAS_HTONL
 796 #undef HAS_NTOHL
 797 #endif
 798
 799 /* The C RTL manual says to undef the macro for DEC C 5.2 and lower. */
 800 #if defined(fileno) && defined(__DECC_VER) && __DECC_VER < 50300000
 801 #  undef fileno
 802 #endif
 803
 804 #define NO_ENVIRON_ARRAY
 805
 806 /* RMSEXPAND options */
 807 #define PERL_RMSEXPAND_M_VMS            0x02 /* Force output to VMS format */
 808 #define PERL_RMSEXPAND_M_LONG           0x04 /* Expand to long name format */
 809 #define PERL_RMSEXPAND_M_VMS_IN         0x08 /* Assume input is VMS already */
 810 #define PERL_RMSEXPAND_M_SYMLINK        0x20 /* Use symbolic link, not target */
 811
 812 #endif  /* __vmsish_h_included */