3 * VMS-specific C header file for perl5.
5 * Last revised: 18-Feb-1997 by Charles Bailey bailey@genetics.upenn.edu
9 #ifndef __vmsish_h_included
10 #define __vmsish_h_included
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 */
18 /* Suppress compiler warnings from DECC for VMS-specific extensions:
19 * GLOBALEXT, NOSHAREEXT, READONLYEXT: global[dr]ef declarations
20 * ADDRCONSTEXT,NEEDCONSTEXT: initialization of data with non-constant values
21 * (e.g. pointer fields of descriptors)
24 # pragma message disable (GLOBALEXT,NOSHAREEXT,READONLYEXT,ADDRCONSTEXT,NEEDCONSTEXT)
27 /* DEC's C compilers and gcc use incompatible definitions of _to(upp|low)er() */
31 #define _toupper(c) (((c) < 'a' || (c) > 'z') ? (c) : (c) & ~040)
35 #define _tolower(c) (((c) < 'A' || (c) > 'Z') ? (c) : (c) | 040)
36 /* DECC 1.3 has a funny definition of abs; it's fixed in DECC 4.0, so this
37 * can go away once DECC 1.3 isn't in use any more. */
38 #if defined(__ALPHA) && defined(__DECC)
40 #define abs(__x) __ABS(__x)
42 #define labs(__x) __LABS(__x)
43 #endif /* __ALPHA && __DECC */
45 /* Assorted things to look like Unix */
47 #ifndef _IOLBF /* gcc's stdio.h doesn't define this */
51 #include <processes.h> /* for vfork() */
54 #include <file.h> /* it's not <sys/file.h>, so don't use I_SYS_FILE */
55 #if defined(__DECC) && defined(__DECC_VER) && __DECC_VER > 20000000
56 # include <unistd.h> /* DECC has this; VAXC and gcc don't */
59 #ifdef NO_PERL_TYPEDEFS /* a2p; we don't want Perl's special routines */
60 # define DONT_MASK_RTL_CALLS
63 /* defined for vms.c so we can see CRTL | defined for a2p */
64 #ifndef DONT_MASK_RTL_CALLS
68 # define getenv(v) my_getenv(v) /* getenv used for regular logical names */
71 /* DECC introduces this routine in the RTL as of VMS 7.0; for now,
72 * we'll use ours, since it gives us the full VMS exit status. */
76 # define Pid_t unsigned int
78 #define waitpid my_waitpid
80 /* Our own contribution to PerlShr's global symbols . . . */
82 # define my_trnlnm Perl_my_trnlnm
83 # define my_getenv Perl_my_getenv
84 # define prime_env_iter Perl_prime_env_iter
85 # define my_setenv Perl_my_setenv
86 # define my_crypt Perl_my_crypt
87 # define my_waitpid Perl_my_waitpid
88 # define my_gconvert Perl_my_gconvert
89 # define do_rmdir Perl_do_rmdir
90 # define kill_file Perl_kill_file
91 # define my_utime Perl_my_utime
92 # define rmsexpand Perl_rmsexpand
93 # define rmsexpand_ts Perl_rmsexpand_ts
94 # define fileify_dirspec Perl_fileify_dirspec
95 # define fileify_dirspec_ts Perl_fileify_dirspec_ts
96 # define pathify_dirspec Perl_pathify_dirspec
97 # define pathify_dirspec_ts Perl_pathify_dirspec_ts
98 # define tounixspec Perl_tounixspec
99 # define tounixspec_ts Perl_tounixspec_ts
100 # define tovmsspec Perl_tovmsspec
101 # define tovmsspec_ts Perl_tovmsspec_ts
102 # define tounixpath Perl_tounixpath
103 # define tounixpath_ts Perl_tounixpath_ts
104 # define tovmspath Perl_tovmspath
105 # define tovmspath_ts Perl_tovmspath_ts
106 # define getredirection Perl_getredirection
107 # define opendir Perl_opendir
108 # define readdir Perl_readdir
109 # define telldir Perl_telldir
110 # define seekdir Perl_seekdir
111 # define closedir Perl_closedir
112 # define vmsreaddirversions Perl_vmsreaddirversions
113 # define getredirection Perl_getredirection
114 # define my_gmtime Perl_my_gmtime
115 # define my_localtime Perl_my_localtime
116 # define my_time Perl_my_time
117 # define cando_by_name Perl_cando_by_name
118 # define flex_fstat Perl_flex_fstat
119 # define flex_stat Perl_flex_stat
120 # define trim_unixpath Perl_trim_unixpath
121 # define my_vfork Perl_my_vfork
122 # define vms_do_aexec Perl_vms_do_aexec
123 # define vms_do_exec Perl_vms_do_exec
124 # define do_aspawn Perl_do_aspawn
125 # define do_spawn Perl_do_spawn
126 # define my_fwrite Perl_my_fwrite
127 # define my_binmode Perl_my_binmode
128 # define my_getpwnam Perl_my_getpwnam
129 # define my_getpwuid Perl_my_getpwuid
130 # define my_getpwent Perl_my_getpwent
131 # define my_endpwent Perl_my_endpwent
132 # define my_getlogin Perl_my_getlogin
133 # define rmscopy Perl_rmscopy
134 # define init_os_extras Perl_init_os_extras
137 /* Delete if at all possible, changing protections if necessary. */
138 #define unlink kill_file
141 * Intercept calls to fork, so we know whether subsequent calls to
142 * exec should be handled in VMSish or Unixish style.
144 #define fork my_vfork
145 #ifndef DONT_MASK_RTL_CALLS /* #defined in vms.c so we see real vfork */
149 # define vfork my_vfork
153 * This symbol is defined if Time_t is an unsigned type on this system.
158 * This symbol is defined if this system has a stat structure declaring
161 #define USE_STAT_RDEV /**/
164 * This symbol, if defined, indicates that error messages should be
165 * should be generated in a format that allows the use of the Acme
166 * GUI/editor's autofind feature.
168 #undef ACME_MESS /**/
170 /* ALTERNATE_SHEBANG:
171 * This symbol, if defined, contains a "magic" string which may be used
172 * as the first line of a Perl program designed to be executed directly
173 * by name, instead of the standard Unix #!. If ALTERNATE_SHEBANG
174 * begins with a character other then #, then Perl will only treat
175 * it as a command line if if finds the string "perl" in the first
176 * word; otherwise it's treated as the first line of code in the script.
177 * (IOW, Perl won't hand off to another interpreter via an alternate
178 * shebang sequence that might be legal Perl code.)
180 #define ALTERNATE_SHEBANG "$"
182 /* Macros to set errno using the VAX thread-safe calls, if present */
183 #if (defined(__DECC) || defined(__DECCXX)) && !defined(__ALPHA)
184 # define set_errno(v) (cma$tis_errno_set_value(v))
185 void cma$tis_errno_set_value(int __value); /* missing in some errno.h */
186 # define set_vaxc_errno(v) (vaxc$errno = (v))
188 # define set_errno(v) (errno = (v))
189 # define set_vaxc_errno(v) (vaxc$errno = (v))
192 /* Support for 'vmsish' behaviors enabled with C<use vmsish> pragma */
194 #define COMPLEX_STATUS 1 /* We track both "POSIX" and VMS values */
196 #define HINT_V_VMSISH 24
197 #define HINT_M_VMSISH_STATUS 0x01000000 /* system, $? return VMS status */
198 #define HINT_M_VMSISH_EXIT 0x02000000 /* exit(1) ==> SS$_NORMAL */
199 #define HINT_M_VMSISH_TIME 0x04000000 /* times are local, not UTC */
200 #define NATIVE_HINTS (hints >> HINT_V_VMSISH) /* used in op.c */
202 #define TEST_VMSISH(h) (curcop->op_private & ((h) >> HINT_V_VMSISH))
203 #define VMSISH_STATUS TEST_VMSISH(HINT_M_VMSISH_STATUS)
204 #define VMSISH_EXIT TEST_VMSISH(HINT_M_VMSISH_EXIT)
205 #define VMSISH_TIME TEST_VMSISH(HINT_M_VMSISH_TIME)
207 /* Handy way to vet calls to VMS system services and RTL routines. */
208 #define _ckvmssts(call) STMT_START { register unsigned long int __ckvms_sts; \
209 if (!((__ckvms_sts=(call))&1)) { \
210 set_errno(EVMSERR); set_vaxc_errno(__ckvms_sts); \
211 croak("Fatal VMS error (status=%d) at %s, line %d", \
212 __ckvms_sts,__FILE__,__LINE__); } } STMT_END
214 /* Same thing, but don't call back to Perl's croak(); useful for errors
215 * occurring during startup, before Perl's state is initialized */
216 #define _ckvmssts_noperl(call) STMT_START { register unsigned long int __ckvms_sts; \
217 if (!((__ckvms_sts=(call))&1)) { \
218 set_errno(EVMSERR); set_vaxc_errno(__ckvms_sts); \
219 fprintf(Perl_debug_log,"Fatal VMS error (status=%d) at %s, line %d", \
220 __ckvms_sts,__FILE__,__LINE__); lib$signal(__ckvms_sts); } } STMT_END
222 #ifdef VMS_DO_SOCKETS
223 #include "sockadapt.h"
226 #define BIT_BUCKET "_NLA0:"
227 #define PERL_SYS_INIT(c,v) getredirection((c),(v))
228 #define PERL_SYS_TERM()
229 #define dXSUB_SYS int dummy
234 * This symbol, if defined, indicates that the program is running under
235 * VMS. It's a symbol automagically defined by all VMS C compilers I've seen.
236 * Just in case, however . . . */
242 * This symbol, if defined, indicates that the ioctl() routine is
243 * available to set I/O characteristics
245 #undef HAS_IOCTL /**/
248 * This symbol, if defined, indicates that the routine utime() is
249 * available to update the access and modification times of files.
251 #define HAS_UTIME /**/
254 * This symbol, if defined, indicates that the getgrnam(),
255 * getgrgid(), and getgrent() routines are available to
258 #undef HAS_GROUP /**/
261 * This symbol, if defined, indicates that the getpwnam(),
262 * getpwuid(), and getpwent() routines are available to
263 * get password entries.
265 #define HAS_PASSWD /**/
271 * This symbol, if defined, indicates that the program should
272 * use the routine my_binmode(FILE *fp, char iotype) to insure
273 * that a file is in "binary" mode -- that is, that no translation
274 * of bytes occurs on read or write operations.
279 * fwrite1() should be a routine with the same calling sequence as fwrite(),
280 * but which outputs all of the bytes requested as a single stream (unlike
281 * fwrite() itself, which on some systems outputs several distinct records
282 * if the number_of_items parameter is >1).
284 #define fwrite1 my_fwrite
286 /* Use our own rmdir() */
287 #define rmdir(name) do_rmdir(name)
289 /* Assorted fiddling with sigs . . . */
291 #define ABORT() abort()
292 /* VAXC's signal.h doesn't #define SIG_ERR, but provides BADSIG instead. */
293 #if !defined(SIG_ERR) && defined(BADSIG)
294 # define SIG_ERR BADSIG
298 /* Used with our my_utime() routine in vms.c */
303 #define utime my_utime
305 /* This is what times() returns, but <times.h> calls it tbuffer_t on VMS
306 * prior to v7.0. We check the DECC manifest to see whether it's already
307 * done this for us, relying on the fact that perl.h #includes <time.h>
308 * before it #includes "vmsish.h".
313 clock_t tms_utime; /* user time */
314 clock_t tms_stime; /* system time - always 0 on VMS */
315 clock_t tms_cutime; /* user time, children */
316 clock_t tms_cstime; /* system time, children - always 0 on VMS */
319 /* The new headers change the times() prototype to tms from tbuffer */
320 # define tbuffer_t struct tms
323 /* Prior to VMS 7.0, the CRTL gmtime() routine was a stub which always
324 * returned NULL. Substitute our own routine, which uses the logical
325 * SYS$TIMEZONE_DIFFERENTIAL, whcih the native UTC support routines
326 * in VMS 6.0 or later use. We also add shims for time() and localtime()
327 * so we can run on UTC by default.
329 #define gmtime(t) my_gmtime(t)
330 #define localtime(t) my_localtime(t)
331 #define time(t) my_time(t)
333 /* VMS doesn't use a real sys_nerr, but we need this when scanning for error
334 * messages in text strings . . .
337 #define sys_nerr EVMSERR /* EVMSERR is as high as we can go. */
339 /* Look up new %ENV values on the fly */
340 #define DYNAMIC_ENV_FETCH 1
341 #define ENV_HV_NAME "%EnV%VmS%"
342 /* Special getenv function for retrieving %ENV elements. */
343 #define ENV_getenv(v) my_getenv(v)
346 /* Thin jacket around cuserid() tomatch Unix' calling sequence */
347 #define getlogin my_getlogin
349 /* Ditto for sys$hash_passwrod() . . . */
350 #define crypt my_crypt
352 /* Use our own stat() clones, which handle Unix-style directory names */
353 #define Stat(name,bufptr) flex_stat(name,bufptr)
354 #define Fstat(fd,bufptr) flex_fstat(fd,bufptr)
356 /* By default, flush data all the way to disk, not just to RMS buffers */
357 #define Fflush(fp) ((fflush(fp) || fsync(fileno(fp))) ? EOF : 0)
359 /* Setup for the dirent routines:
360 * opendir(), closedir(), readdir(), seekdir(), telldir(), and
361 * vmsreaddirversions(), and preprocessor stuff on which these depend:
362 * Written by Rich $alz, <rsalz@bbn.com> in August, 1990.
364 /* Data structure returned by READDIR(). */
366 char d_name[256]; /* File name */
367 int d_namlen; /* Length of d_name */
368 int vms_verscount; /* Number of versions */
369 int vms_versions[20]; /* Version numbers */
372 /* Handle returned by opendir(), used by the other routines. You
373 * are not supposed to care what's inside this structure. */
374 typedef struct _dirdesc {
376 int vms_wantversions;
377 unsigned long int count;
380 struct dsc$descriptor_s pat;
383 #define rewinddir(dirp) seekdir((dirp), 0)
385 /* used for our emulation of getpw* */
387 char *pw_name; /* Username */
389 Uid_t pw_uid; /* UIC member number */
390 Gid_t pw_gid; /* UIC group number */
391 char *pw_comment; /* Default device/directory (Unix-style) */
392 char *pw_gecos; /* Owner */
393 char *pw_dir; /* Default device/directory (VMS-style) */
394 char *pw_shell; /* Default CLI name (eg. DCL) */
396 #define pw_unixdir pw_comment /* Default device/directory (Unix-style) */
397 #define getpwnam my_getpwnam
398 #define getpwuid my_getpwuid
399 #define getpwent my_getpwent
400 #define endpwent my_endpwent
401 #define setpwent my_endpwent
403 /* Our own stat_t substitute, since we play with st_dev and st_ino -
404 * we want atomic types so Unix-bound code which compares these fields
405 * for two files will work most of the time under VMS.
406 * N.B. 1. The st_ino hack assumes that sizeof(unsigned short[3]) ==
407 * sizeof(unsigned) + sizeof(unsigned short). We can't use a union type
408 * to map the unsigned int we want and the unsigned short[3] the CRTL
409 * returns into the same member, since gcc has different ideas than DECC
410 * and VAXC about sizing union types.
411 * N.B 2. The routine cando() in vms.c assumes that &stat.st_ino is the
414 /* First, grab the system types, so we don't clobber them later */
416 /* Since we've got to match the size of the CRTL's stat_t, we need
417 * to mimic DECC's alignment settings.
419 #if defined(__DECC) || defined(__DECCXX)
420 # pragma __member_alignment __save
421 # pragma __nomember_alignment
424 # pragma __message __save
425 # pragma __message disable (__MISALGNDSTRCT)
426 # pragma __message disable (__MISALGNDMEM)
430 char *st_devnam; /* pointer to device name */
431 unsigned st_ino; /* hack - CRTL uses unsigned short[3] for */
432 unsigned short rvn; /* FID (num,seq,rvn) */
433 unsigned short st_mode; /* file "mode" i.e. prot, dir, reg, etc. */
434 int st_nlink; /* for compatibility - not really used */
435 unsigned st_uid; /* from ACP - QIO uic field */
436 unsigned short st_gid; /* group number extracted from st_uid */
437 dev_t st_rdev; /* for compatibility - always zero */
438 off_t st_size; /* file size in bytes */
439 unsigned st_atime; /* file access time; always same as st_mtime */
440 unsigned st_mtime; /* last modification time */
441 unsigned st_ctime; /* file creation time */
442 char st_fab_rfm; /* record format */
443 char st_fab_rat; /* record attributes */
444 char st_fab_fsz; /* fixed header size */
445 unsigned st_dev; /* encoded device name */
447 typedef unsigned mydev_t;
448 typedef unsigned myino_t;
449 #ifndef DONT_MASK_RTL_CALLS /* defined for vms.c so we can see RTL calls */
454 # define dev_t mydev_t
455 # define ino_t myino_t
457 #if defined(__DECC) || defined(__DECCXX)
458 # pragma __member_alignment __restore
461 # pragma __message __restore
463 /* Cons up a 'delete' bit for testing access */
464 #define S_IDUSR (S_IWUSR | S_IXUSR)
465 #define S_IDGRP (S_IWGRP | S_IXGRP)
466 #define S_IDOTH (S_IWOTH | S_IXOTH)
468 /* Prototypes for functions unique to vms.c. Don't include replacements
469 * for routines in the mainline source files excluded by #ifndef VMS;
470 * their prototypes are already in proto.h.
472 * In order to keep Gen_ShrFls.Pl happy, functions which are to be made
473 * available to images linked to PerlShr.Exe must be declared between the
474 * __VMS_PROTOTYPES__ and __VMS_SEPYTOTORP__ lines, and must be in the form
475 * <data type><TAB>name<WHITESPACE>_((<prototype args>));
478 #ifdef NO_PERL_TYPEDEFS
479 /* We don't have Perl typedefs available (e.g. when building a2p), so
480 we fake them here. N.B. There is *no* guarantee that the faked
481 prototypes will actually match the real routines. If you want to
482 call Perl routines, include perl.h to get the real typedefs. */
485 # define __MY_BOOL_TYPE_FAKE
489 # define __MY_I32_TYPE_FAKE
492 # define SV void /* Since we only see SV * in prototypes */
493 # define __MY_SV_TYPE_FAKE
497 void prime_env_iter _((void));
498 void getredirection _((int *, char ***));
499 void init_os_extras _(());
500 /* prototype section start marker; `typedef' passes through cpp */
501 typedef char __VMS_PROTOTYPES__;
502 int my_trnlnm _((char *, char *, unsigned long int));
503 char * my_getenv _((char *));
504 char * my_crypt _((const char *, const char *));
505 Pid_t my_waitpid _((Pid_t, int *, int));
506 char * my_gconvert _((double, int, int, char *));
507 int do_rmdir _((char *));
508 int kill_file _((char *));
509 int my_utime _((char *, struct utimbuf *));
510 char * rmsexpand _((char *, char *, char *, unsigned));
511 char * rmsexpand_ts _((char *, char *, char *, unsigned));
512 char * fileify_dirspec _((char *, char *));
513 char * fileify_dirspec_ts _((char *, char *));
514 char * pathify_dirspec _((char *, char *));
515 char * pathify_dirspec_ts _((char *, char *));
516 char * tounixspec _((char *, char *));
517 char * tounixspec_ts _((char *, char *));
518 char * tovmsspec _((char *, char *));
519 char * tovmsspec_ts _((char *, char *));
520 char * tounixpath _((char *, char *));
521 char * tounixpath_ts _((char *, char *));
522 char * tovmspath _((char *, char *));
523 char * tovmspath_ts _((char *, char *));
524 void getredirection _(());
525 DIR * opendir _((char *));
526 struct dirent * readdir _((DIR *));
527 long telldir _((DIR *));
528 void seekdir _((DIR *, long));
529 void closedir _((DIR *));
530 void vmsreaddirversions _((DIR *, int));
531 struct tm * my_gmtime _((const time_t *));
532 struct tm * my_localtime _((const time_t *));
533 time_t my_time _((time_t *));
534 I32 cando_by_name _((I32, I32, char *));
535 int flex_fstat _((int, struct mystat *));
536 int flex_stat _((char *, struct mystat *));
537 int trim_unixpath _((char *, char*, int));
539 bool vms_do_aexec _((SV *, SV **, SV **));
540 bool vms_do_exec _((char *));
541 unsigned long int do_aspawn _((SV *, SV **, SV **));
542 unsigned long int do_spawn _((char *));
543 int my_fwrite _((void *, size_t, size_t, FILE *));
544 FILE * my_binmode _((FILE *, char));
545 struct passwd * my_getpwnam _((char *name));
546 struct passwd * my_getpwuid _((Uid_t uid));
547 struct passwd * my_getpwent _(());
548 void my_endpwent _(());
549 char * my_getlogin _(());
550 int rmscopy _((char *, char *, int));
551 typedef char __VMS_SEPYTOTORP__;
552 /* prototype section end marker; `typedef' passes through cpp */
554 #ifdef NO_PERL_TYPEDEFS /* We'll try not to scramble later files */
555 # ifdef __MY_BOOL_TYPE_FAKE
557 # undef __MY_BOOL_TYPE_FAKE
559 # ifdef __MY_I32_TYPE_FAKE
561 # undef __MY_I32_TYPE_FAKE
563 # ifdef __MY_SV_TYPE_FAKE
565 # undef __MY_SV_TYPE_FAKE
569 #ifndef VMS_DO_SOCKETS
570 /* This relies on tricks in perl.h to pick up that these manifest constants
571 * are undefined and set up conversion routines. It will then redefine
572 * these manifest constants, so the actual values will match config.h
580 #define TMPPATH "sys$scratch:perl-eXXXXXX"
582 #endif /* __vmsish_h_included */