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