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