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