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