This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Add void casts to VMS-specific bail-out macro.
[perl5.git] / vms / vmsish.h
CommitLineData
82dd182c 1/* vmsish.h
a0d0e21e 2 *
82dd182c 3 * VMS-specific C header file for perl5.
a0d0e21e 4 *
82dd182c
CB
5 * Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
6 * 2002, 2003, 2004, 2005, 2006, 2007 by Charles Bailey and others.
2497a41f 7 *
82dd182c
CB
8 * You may distribute under the terms of either the GNU General Public
9 * License or the Artistic License, as specified in the README file.
10 *
11 * Please see Changes*.* or the Perl Repository Browser for revision history.
a0d0e21e
LW
12 */
13
14#ifndef __vmsish_h_included
15#define __vmsish_h_included
16
17#include <descrip.h> /* for dirent struct definitions */
748a9306
LW
18#include <libdef.h> /* status codes for various places */
19#include <rmsdef.h> /* at which errno and vaxc$errno are */
20#include <ssdef.h> /* explicitly set in the perl source code */
4fdae800 21#include <stsdef.h> /* bitmasks for exit status testing */
748a9306 22
4633a7c4 23/* Suppress compiler warnings from DECC for VMS-specific extensions:
e518068a
PP
24 * ADDRCONSTEXT,NEEDCONSTEXT: initialization of data with non-constant values
25 * (e.g. pointer fields of descriptors)
26 */
929df5ff 27#ifdef __DECC
22d4bb9c
CB
28# pragma message disable (ADDRCONSTEXT,NEEDCONSTEXT)
29#endif
929df5ff
CB
30#ifdef __DECCXX
31# pragma message informational (INTSIGNCHANGE,CASTQUALTYP,ASSCOMMEA,NOCTOBUTCONREFM)
32#endif
e518068a 33
748a9306
LW
34/* DEC's C compilers and gcc use incompatible definitions of _to(upp|low)er() */
35#ifdef _toupper
36# undef _toupper
37#endif
38#define _toupper(c) (((c) < 'a' || (c) > 'z') ? (c) : (c) & ~040)
39#ifdef _tolower
40# undef _tolower
41#endif
42#define _tolower(c) (((c) < 'A' || (c) > 'Z') ? (c) : (c) | 040)
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
988c775c
JM
62#include <namdef.h>
63
64/* Set the maximum filespec size here as it is larger for EFS file
65 * specifications.
66 */
67#ifndef __VAX
68#ifndef VMS_MAXRSS
69#ifdef NAML$C_MAXRSS
70#define VMS_MAXRSS (NAML$C_MAXRSS+1)
71#ifndef VMS_LONGNAME_SUPPORT
72#define VMS_LONGNAME_SUPPORT 1
73#endif /* VMS_LONGNAME_SUPPORT */
74#endif /* NAML$C_MAXRSS */
75#endif /* VMS_MAXRSS */
76#endif
77
78#ifndef VMS_MAXRSS
79#define VMS_MAXRSS (NAM$C_MAXRSS + 1)
80#endif
81
82#ifndef MAXPATHLEN
83#define MAXPATHLEN (VMS_MAXRSS - 1)
84#endif
85
86
562a7b0c
CB
87/* Note that we do, in fact, have this */
88#define HAS_GETENV_SV
cc077a9f 89#define HAS_GETENV_LEN
562a7b0c 90
f9fd8397
NC
91
92#ifndef PERL_FOR_X2P
fd8cd3a3 93
aa689395
PP
94#ifndef DONT_MASK_RTL_CALLS
95# ifdef getenv
96# undef getenv
97# endif
562a7b0c 98 /* getenv used for regular logical names */
fd8cd3a3 99# define getenv(v) Perl_my_getenv(aTHX_ v,TRUE)
aa689395 100#endif
19c10e8f
CB
101#ifdef getenv_len
102# undef getenv_len
103#endif
fd8cd3a3 104#define getenv_len(v,l) Perl_my_getenv_len(aTHX_ v,l,TRUE)
aa689395 105
4fdae800
PP
106/* DECC introduces this routine in the RTL as of VMS 7.0; for now,
107 * we'll use ours, since it gives us the full VMS exit status. */
4fdae800
PP
108#define waitpid my_waitpid
109
61bb5906
CB
110/* Don't redeclare standard RTL routines in Perl's header files;
111 * VMS history or extensions makes some of the formal protoypes
112 * differ from the common Unix forms.
113 */
114#define DONT_DECLARE_STD 1
115
bf109933 116/* Our own contribution to PerlShr's global symbols . . . */
0c43a9cd 117
5c84aa53 118#if !defined(PERL_IMPLICIT_CONTEXT)
4b19af01 119#define opendir Perl_opendir
4fdf8f88 120#define rename Perl_rename
2497a41f 121#define seekdir Perl_seekdir
fd8cd3a3 122#define readdir Perl_readdir
a9852f7c 123#define readdir_r Perl_readdir_r
5c84aa53 124#else
4b19af01 125#define opendir(a) Perl_opendir(aTHX_ a)
4fdf8f88 126#define rename(a,b) Perl_rename(aTHX_ a,b)
fd8cd3a3 127#define seekdir(a,b) Perl_seekdir(aTHX_ a,b)
fd8cd3a3 128#define readdir(a) Perl_readdir(aTHX_ a)
a9852f7c 129#define readdir_r(a,b,c) Perl_readdir_r(aTHX_ a,b,c)
5c84aa53 130#endif
0c43a9cd
CB
131#define closedir(a) Perl_closedir(a)
132#define telldir(a) Perl_telldir(a)
133#define vmsreaddirversions(a,b) Perl_vmsreaddirversions(a,b)
134
135#define cando_by_name(a,b,c) Perl_cando_by_name(aTHX_ a,b,c)
136#define do_rmdir(a) Perl_do_rmdir(aTHX_ a)
137#define fileify_dirspec(a,b) Perl_fileify_dirspec(aTHX_ a,b)
138#define fileify_dirspec(a,b) Perl_fileify_dirspec(aTHX_ a,b)
139#define fileify_dirspec_ts(a,b) Perl_fileify_dirspec_ts(aTHX_ a,b)
140#define fileify_dirspec_ts(a,b) Perl_fileify_dirspec_ts(aTHX_ a,b)
141#define fileify_dirspec_utf8(a,b,c) Perl_fileify_dirspec(aTHX_ a,b,utf8)
142#define fileify_dirspec_utf8_ts(a,b,c) Perl_fileify_dirspec_ts(aTHX_ a,b,utf8)
143#define flex_fstat(a,b) Perl_flex_fstat(aTHX_ a,b)
144#define flex_lstat(a,b) Perl_flex_lstat(aTHX_ a,b)
145#define flex_stat(a,b) Perl_flex_stat(aTHX_ a,b)
146#define init_os_extras Perl_init_os_extras
147#define kill_file(a) Perl_kill_file(aTHX_ a)
148#define my_chdir(a) Perl_my_chdir(aTHX_ a)
149#define my_chmod(a,b) Perl_my_chmod(aTHX_ a,b)
150#define my_crypt(a,b) Perl_my_crypt(aTHX_ a,b)
151#define my_endpwent() Perl_my_endpwent(aTHX)
152#define my_fclose(a) Perl_my_fclose(a)
153#define my_fdopen(a,b) Perl_my_fdopen(a,b)
154#define my_flush(a) Perl_my_flush(aTHX_ a)
155#define my_fwrite(a,b,c,d) Perl_my_fwrite(a,b,c,d)
156#define my_fgetname(a,b) Perl_my_fgetname(a,b)
157#define my_gconvert(a,b,c,d) Perl_my_gconvert(a,b,c,d)
158#define my_getenv(a,b) Perl_my_getenv(aTHX_ a,b)
159#define my_getenv_len(a,b,c) Perl_my_getenv_len(aTHX_ a,b,c)
160#define my_getlogin Perl_my_getlogin
161#define my_getpwent() Perl_my_getpwent(aTHX)
162#define my_getpwnam(a) Perl_my_getpwnam(aTHX_ a)
163#define my_getpwuid(a) Perl_my_getpwuid(aTHX_ a)
164#define my_gmtime(a) Perl_my_gmtime(aTHX_ a)
165#define my_localtime(a) Perl_my_localtime(aTHX_ a)
166#define my_mkdir(a,b) Perl_my_mkdir(aTHX_ a,b)
167#define my_sigemptyset(a) Perl_my_sigemptyset(a)
168#define my_sigfillset(a) Perl_my_sigfillset(a)
169#define my_sigaddset(a,b) Perl_my_sigaddset(a,b)
170#define my_sigdelset(a,b,c) Perl_my_sigdelset(a,b,c)
171#define my_sigismember(a,b) Perl_my_sigismember(a,b)
172#define my_sigprocmask(a,b,c) Perl_my_sigprocmask(a,b,c)
2ee6e19d 173#ifdef HAS_SYMLINK
0c43a9cd
CB
174# define my_symlink(a,b) Perl_my_symlink(aTHX_ a,b)
175#endif
176#define my_time(a) Perl_my_time(aTHX_ a)
177#define my_tmpfile Perl_my_tmpfile
178#define my_trnlnm(a,b,c) Perl_my_trnlnm(aTHX_ a,b,c)
179#define my_utime(a,b) Perl_my_utime(aTHX_ a,b)
180#define my_vfork Perl_my_vfork
181#define my_waitpid(a,b,c) Perl_my_waitpid(aTHX_ a,b,c)
182#define pathify_dirspec(a,b) Perl_pathify_dirspec(aTHX a,b)
183#define pathify_dirspec_ts(a,b) Perl_pathify_dirspec_ts(aTHX a,b)
184#define pathify_dirspec_utf8(a,b,c) Perl_pathify_dirspec_utf8(aTHX a,b,c)
185#define pathify_dirspec_utf8_ts(a,b,c) Perl_pathify_dirspec_utf8_ts(aTHX a,b,c)
186#define prime_env_iter Perl_prime_env_iter
187#define rmscopy(a,b,c) Perl_rmscopy(aTHX_ a,b,c)
188#define rmsexpand(a,b,c,d) Perl_rmsexpand_utf8(aTHX_ a,b,c,d,NULL,NULL)
189#define rmsexpand_ts(a,b,c,d) Perl_rmsexpand_utf8_ts(aTHX_ a,b,c,d,NULL,NULL)
190#define rmsexpand_utf8(a,b,c,d,e,f) Perl_rmsexpand_utf8(aTHX_ a,b,c,d,e,f)
191#define rmsexpand_utf8_ts(a,b,c,d,e,f) Perl_rmsexpand_utf8_ts(aTHX_ a,b,c,d,e,f)
192#define tounixpath(a,b) Perl_tounixpath_utf8(aTHX_ a,b,NULL)
193#define tounixpath_ts(a,b) Perl_tounixpath_utf8_ts(aTHX_ a,b,NULL)
194#define tounixpath_utf8(a,b,c) Perl_tounixpath_utf8(aTHX_ a,b,c)
195#define tounixpath_utf8_ts(a,b,c) Perl_tounixpath_utf8_ts(aTHX_ a,b,c)
196#define tounixspec(a,b) Perl_tounixspec_utf8(aTHX_ a,b,NULL)
197#define tounixspec_ts(a,b) Perl_tounixspec_utf8_ts(aTHX_ a,b,NULL)
198#define tounixspec_utf8(a,b,c) Perl_tounixspec_utf8(aTHX_ a,b,c)
199#define tounixspec_utf8_ts(a,b,c) Perl_tounixspec_utf8_ts(aTHX_ a,b,c)
200#define tovmspath(a,b) Perl_tovmspath_utf8(aTHX_ a,b,NULL)
201#define tovmspath_ts(a,b) Perl_tovmspath_utf8_ts(aTHX_ a,b,NULL)
202#define tovmspath_utf8(a,b,c) Perl_tovmspath_utf8(aTHX_ a,b,c)
203#define tovmspath_utf8_ts(a,b,c) Perl_tovmspath_utf8_ts(aTHX_ a,b,c)
204#define tovmsspec(a,b) Perl_tovmsspec_utf8(aTHX_ a,b,NULL)
205#define tovmsspec_ts(a,b) Perl_tovmsspec_utf8_ts(aTHX_ a,b)
206#define tovmsspec_utf8(a,b,c) Perl_tovmsspec_utf8(aTHX_ a,b,c)
207#define tovmsspec_utf8_ts(a,b,c) Perl_tovmsspec_utf8_ts(aTHX_ a,b,c)
208#define trim_unixpath(a,b,c) Perl_trim_unixpath(aTHX_ a,b,c)
209#define vms_do_aexec(a,b,c) Perl_vms_do_aexec(aTHX_ a,b,c)
210#define vms_do_exec(a) Perl_vms_do_exec(aTHX_ a)
211#define vms_case_tolerant(a) Perl_vms_case_tolerant(a)
212#define vms_image_init(a,b) Perl_vms_image_init(a,b)
213#define vms_realname(a,b,c) Perl_vms_realname(aTHX_ a,b,c)
214#define vms_realpath(a,b,c) Perl_vms_realpath(aTHX_ a,b,c)
215#define vmssetenv(a,b,c) Perl_vmssetenv(aTHX_ a,b,c)
216#define vmstrnenv(a,b,c,d,e) Perl_vmstrnenv(a,b,c,d,e)
0db50132 217#define vmssetuserlnm(a,b) Perl_vmssetuserlnm(a,b)
bf109933
PP
218
219/* Delete if at all possible, changing protections if necessary. */
0c43a9cd 220#define unlink(a) kill_file(a)
748a9306 221
0414b1a0
PP
222/*
223 * Intercept calls to fork, so we know whether subsequent calls to
224 * exec should be handled in VMSish or Unixish style.
225 */
226#define fork my_vfork
aa689395 227#ifndef DONT_MASK_RTL_CALLS /* #defined in vms.c so we see real vfork */
0414b1a0
PP
228# ifdef vfork
229# undef vfork
230# endif
231# define vfork my_vfork
232#endif
233
674d6c38
CB
234/*
235 * Toss in a shim to tmpfile which creates a plain temp file if the
236 * RMS tmp mechanism won't work (e.g. if someone is relying on ACLs
237 * from a specific directory to permit creation of files).
238 */
239#ifndef DONT_MASK_RTL_CALLS
fd8cd3a3 240# define tmpfile Perl_my_tmpfile
674d6c38 241#endif
f9fd8397 242#endif
674d6c38
CB
243
244
0414b1a0
PP
245/* BIG_TIME:
246 * This symbol is defined if Time_t is an unsigned type on this system.
247 */
248#define BIG_TIME
249
0414b1a0
PP
250/* ACME_MESS:
251 * This symbol, if defined, indicates that error messages should be
252 * should be generated in a format that allows the use of the Acme
253 * GUI/editor's autofind feature.
254 */
255#undef ACME_MESS /**/
e518068a 256
44a8e56a
PP
257/* ALTERNATE_SHEBANG:
258 * This symbol, if defined, contains a "magic" string which may be used
259 * as the first line of a Perl program designed to be executed directly
260 * by name, instead of the standard Unix #!. If ALTERNATE_SHEBANG
261 * begins with a character other then #, then Perl will only treat
262 * it as a command line if if finds the string "perl" in the first
263 * word; otherwise it's treated as the first line of code in the script.
264 * (IOW, Perl won't hand off to another interpreter via an alternate
265 * shebang sequence that might be legal Perl code.)
266 */
267#define ALTERNATE_SHEBANG "$"
268
748a9306
LW
269/* Macros to set errno using the VAX thread-safe calls, if present */
270#if (defined(__DECC) || defined(__DECCXX)) && !defined(__ALPHA)
271# define set_errno(v) (cma$tis_errno_set_value(v))
774d564b 272 void cma$tis_errno_set_value(int __value); /* missing in some errno.h */
748a9306
LW
273# define set_vaxc_errno(v) (vaxc$errno = (v))
274#else
275# define set_errno(v) (errno = (v))
276# define set_vaxc_errno(v) (vaxc$errno = (v))
277#endif
278
ff0cee69
PP
279/* Support for 'vmsish' behaviors enabled with C<use vmsish> pragma */
280
281#define COMPLEX_STATUS 1 /* We track both "POSIX" and VMS values */
282
aa689395 283#define HINT_V_VMSISH 24
744a34f9 284#define HINT_M_VMSISH_STATUS 0x40000000 /* system, $? return VMS status */
a0ed51b3 285#define HINT_M_VMSISH_TIME 0x80000000 /* times are local, not UTC */
6b88bc9c 286#define NATIVE_HINTS (PL_hints >> HINT_V_VMSISH) /* used in op.c */
ff0cee69 287
a520a2c4 288#ifdef PERL_IMPLICIT_CONTEXT
43a65c28 289# define TEST_VMSISH(h) (my_perl && PL_curcop && (PL_curcop->op_private & ((h) >> HINT_V_VMSISH)))
a520a2c4 290#else
43a65c28 291# define TEST_VMSISH(h) (PL_curcop && (PL_curcop->op_private & ((h) >> HINT_V_VMSISH)))
a520a2c4 292#endif
ff0cee69 293#define VMSISH_STATUS TEST_VMSISH(HINT_M_VMSISH_STATUS)
ff0cee69
PP
294#define VMSISH_TIME TEST_VMSISH(HINT_M_VMSISH_TIME)
295
96e176bf
CL
296/* VMS-specific data storage */
297
298#define HAVE_INTERP_INTERN
299struct interp_intern {
300 int hushed;
7a7fd8e0 301 int posix_exit;
3ff49832 302 double inv_rand_max;
96e176bf
CL
303};
304#define VMSISH_HUSHED (PL_sys_intern.hushed)
305#define MY_INV_RAND_MAX (PL_sys_intern.inv_rand_max)
7a7fd8e0 306#define MY_POSIX_EXIT (PL_sys_intern.posix_exit)
96e176bf 307
562a7b0c
CB
308/* Flags for vmstrnenv() */
309#define PERL__TRNENV_SECURE 0x01
843027b0 310#define PERL__TRNENV_JOIN_SEARCHLIST 0x02
562a7b0c 311
748a9306 312/* Handy way to vet calls to VMS system services and RTL routines. */
5aaab254 313#define _ckvmssts(call) STMT_START { unsigned long int __ckvms_sts; \
748a9306
LW
314 if (!((__ckvms_sts=(call))&1)) { \
315 set_errno(EVMSERR); set_vaxc_errno(__ckvms_sts); \
5c84aa53 316 Perl_croak(aTHX_ "Fatal VMS error (status=%d) at %s, line %d", \
bf109933 317 __ckvms_sts,__FILE__,__LINE__); } } STMT_END
a0d0e21e 318
0414b1a0
PP
319/* Same thing, but don't call back to Perl's croak(); useful for errors
320 * occurring during startup, before Perl's state is initialized */
5aaab254 321#define _ckvmssts_noperl(call) STMT_START { unsigned long int __ckvms_sts; \
0414b1a0
PP
322 if (!((__ckvms_sts=(call))&1)) { \
323 set_errno(EVMSERR); set_vaxc_errno(__ckvms_sts); \
d6cfa669
CB
324 (void)fprintf(stderr,"Fatal VMS error (status=%d) at %s, line %d", \
325 __ckvms_sts,__FILE__,__LINE__); (void)lib$signal(__ckvms_sts); } } STMT_END
0414b1a0 326
a0d0e21e 327#ifdef VMS_DO_SOCKETS
86774884
CB
328#define PERL_SOCK_SYSREAD_IS_RECV
329#define PERL_SOCK_SYSWRITE_IS_SEND
a0d0e21e
LW
330#endif
331
2497a41f 332#define BIT_BUCKET "/dev/null"
cbec8ebe
DM
333#define PERL_SYS_INIT_BODY(c,v) MALLOC_CHECK_TAINT2(*c,*v) vms_image_init((c),(v)); PERLIO_INIT; MALLOC_INIT
334#define PERL_SYS_TERM_BODY() HINTS_REFCNT_TERM; OP_REFCNT_TERM; PERLIO_TERM; MALLOC_TERM
8cc95fdb 335#define dXSUB_SYS
a0d0e21e
LW
336#define HAS_KILL
337#define HAS_WAIT
338
b79b76e0
NC
339#ifndef PERL_CORE
340# define PERL_FS_VER_FMT "%d_%d_%d"
341#endif
342#define PERL_FS_VERSION STRINGIFY(PERL_REVISION) "_" \
343 STRINGIFY(PERL_VERSION) "_" \
344 STRINGIFY(PERL_SUBVERSION)
c93fa817
GS
345/* Temporary; we need to add support for this to Configure.Com */
346#ifdef PERL_INC_VERSION_LIST
347# undef PERL_INC_VERSION_LIST
348#endif
146174a9 349
e518068a
PP
350/* VMS:
351 * This symbol, if defined, indicates that the program is running under
352 * VMS. It's a symbol automagically defined by all VMS C compilers I've seen.
353 * Just in case, however . . . */
2fbb330f 354/* Note that code really should be using __VMS to comply with ANSI */
e518068a
PP
355#ifndef VMS
356#define VMS /**/
357#endif
358
359/* HAS_IOCTL:
360 * This symbol, if defined, indicates that the ioctl() routine is
361 * available to set I/O characteristics
a0d0e21e 362 */
670137c2 363#define HAS_IOCTL /**/
e518068a
PP
364
365/* HAS_UTIME:
366 * This symbol, if defined, indicates that the routine utime() is
367 * available to update the access and modification times of files.
368 */
369#define HAS_UTIME /**/
a0d0e21e 370
e518068a 371/* HAS_GROUP
28e8609d
JH
372 * This symbol, if defined, indicates that the getgrnam() and
373 * getgrgid() routines are available to get group entries.
374 * The getgrent() has a separate definition, HAS_GETGRENT.
e518068a 375 */
211b0ba3
JM
376#if __CRTL_VER >= 70302000
377#define HAS_GROUP /**/
378#else
e518068a 379#undef HAS_GROUP /**/
211b0ba3 380#endif
e518068a
PP
381
382/* HAS_PASSWD
28e8609d
JH
383 * This symbol, if defined, indicates that the getpwnam() and
384 * getpwuid() routines are available to get password entries.
385 * The getpwent() has a separate definition, HAS_GETPWENT.
e518068a
PP
386 */
387#define HAS_PASSWD /**/
388
389#define HAS_KILL
390#define HAS_WAIT
391
0414b1a0
PP
392/* USEMYBINMODE
393 * This symbol, if defined, indicates that the program should
16fe6d59 394 * use the routine my_binmode(FILE *fp, char iotype, int mode) to insure
0414b1a0
PP
395 * that a file is in "binary" mode -- that is, that no translation
396 * of bytes occurs on read or write operations.
397 */
562a7b0c 398#undef USEMYBINMODE
0414b1a0 399
61bb5906
CB
400/* Stat_t:
401 * This symbol holds the type used to declare buffers for information
402 * returned by stat(). It's usually just struct stat. It may be necessary
403 * to include <sys/stat.h> and <sys/types.h> to get any typedef'ed
404 * information.
405 */
406/* VMS:
407 * We need this typedef to point to the new type even if DONT_MASK_RTL_CALLS
408 * is in effect, since Perl's thread.h embeds one of these structs in its
409 * thread data struct, and our struct mystat is a different size from the
410 * regular struct stat (cf. note above about having to pad struct to work
411 * around bug in compiler.)
412 * It's OK to pass one of these to the RTL's stat(), though, since the
413 * fields it fills are the same in each struct.
414 */
415#define Stat_t struct mystat
416
417/* USE_STAT_RDEV:
418* This symbol is defined if this system has a stat structure declaring
419* st_rdev
420* VMS: Field exists in POSIXish version of struct stat(), but is not used.
2497a41f
JM
421*
422* No definition of what value an operating system or file system should
423* put in the st_rdev field has been found by me so far. Examination of
424* LINUX source code indicates that the value is both very platform and
425* file system specific, with many filesystems just putting 1 or 0 in it.
426* J. Malmberg.
61bb5906
CB
427*/
428#undef USE_STAT_RDEV /**/
429
a0d0e21e
LW
430/*
431 * fwrite1() should be a routine with the same calling sequence as fwrite(),
432 * but which outputs all of the bytes requested as a single stream (unlike
433 * fwrite() itself, which on some systems outputs several distinct records
434 * if the number_of_items parameter is >1).
435 */
436#define fwrite1 my_fwrite
437
bc10a425
CB
438
439#ifndef DONT_MASK_RTL_CALLS
a15cef0c 440# define fwrite my_fwrite /* for PerlSIO_fwrite */
bc10a425
CB
441# define fdopen my_fdopen
442# define fclose my_fclose
bf8d1304 443# define fgetname(a, b) my_fgetname(a, b)
2ee6e19d
CB
444#ifdef HAS_SYMLINK
445# define symlink my_symlink
446#endif
bc10a425
CB
447#endif
448
449
d27fe803
JH
450/* By default, flush data all the way to disk, not just to RMS buffers */
451#define Fflush(fp) my_flush(fp)
452
a0d0e21e 453/* Use our own rmdir() */
2497a41f 454#ifndef DONT_MASK_RTL_CALLS
a0d0e21e 455#define rmdir(name) do_rmdir(name)
2497a41f 456#endif
a0d0e21e
LW
457
458/* Assorted fiddling with sigs . . . */
459# include <signal.h>
460#define ABORT() abort()
461
704c2eb3
JM
462#ifdef I_UTIME
463#include <utime.h>
464#else
748a9306
LW
465/* Used with our my_utime() routine in vms.c */
466struct utimbuf {
467 time_t actime;
468 time_t modtime;
469};
704c2eb3
JM
470#endif
471#ifndef DONT_MASK_RTL_CALLS
748a9306 472#define utime my_utime
704c2eb3 473#endif
748a9306 474
0414b1a0
PP
475/* This is what times() returns, but <times.h> calls it tbuffer_t on VMS
476 * prior to v7.0. We check the DECC manifest to see whether it's already
477 * done this for us, relying on the fact that perl.h #includes <time.h>
478 * before it #includes "vmsish.h".
479 */
a0d0e21e 480
0414b1a0
PP
481#ifndef __TMS
482 struct tms {
483 clock_t tms_utime; /* user time */
484 clock_t tms_stime; /* system time - always 0 on VMS */
485 clock_t tms_cutime; /* user time, children */
486 clock_t tms_cstime; /* system time, children - always 0 on VMS */
487 };
5f05dabc
PP
488#else
489 /* The new headers change the times() prototype to tms from tbuffer */
490# define tbuffer_t struct tms
0414b1a0 491#endif
a0d0e21e 492
61bb5906
CB
493/* Substitute our own routines for gmtime(), localtime(), and time(),
494 * which allow us to implement the vmsish 'time' pragma, and work
495 * around absence of system-level UTC support on old versions of VMS.
e518068a
PP
496 */
497#define gmtime(t) my_gmtime(t)
ff0cee69
PP
498#define localtime(t) my_localtime(t)
499#define time(t) my_time(t)
61bb5906 500
5c2d7af2
CB
501/*
502 * The C RTL's sigaction fails to check for invalid signal numbers so we
503 * help it out a bit.
504 */
32995a38 505#ifndef DONT_MASK_RTL_CALLS
8df869cb 506# define sigaction(a,b,c) Perl_my_sigaction(aTHX_ a,b,c)
7b62b82b 507#endif
f2610a60
CL
508#ifdef KILL_BY_SIGPRC
509# define kill Perl_my_kill
510#endif
511
e518068a 512
a0d0e21e
LW
513/* VMS doesn't use a real sys_nerr, but we need this when scanning for error
514 * messages in text strings . . .
515 */
516
517#define sys_nerr EVMSERR /* EVMSERR is as high as we can go. */
518
519/* Look up new %ENV values on the fly */
520#define DYNAMIC_ENV_FETCH 1
aa689395 521 /* Special getenv function for retrieving %ENV elements. */
562a7b0c 522#define ENVgetenv(v) my_getenv(v,FALSE)
a6c40364 523#define ENVgetenv_len(v,l) my_getenv_len(v,l,FALSE)
aa689395 524
a0d0e21e 525
22d4bb9c 526/* Thin jacket around cuserid() to match Unix' calling sequence */
c07a80fd
PP
527#define getlogin my_getlogin
528
bc10a425 529/* Ditto for sys$hash_password() . . . */
fd8cd3a3 530#define crypt(a,b) Perl_my_crypt(aTHX_ a,b)
c07a80fd 531
ee8c7f54 532/* Tweak arg to mkdir & chdir first, so we can tolerate trailing /. */
fd8cd3a3 533#define Mkdir(dir,mode) Perl_my_mkdir(aTHX_ (dir),(mode))
ee8c7f54 534#define Chdir(dir) my_chdir((dir))
f1db9cda
JM
535#ifndef DONT_MASK_RTL_CALLS
536#define chmod(file_spec, mode) my_chmod((file_spec), (mode))
537#endif
8cc95fdb 538
a0d0e21e
LW
539/* Use our own stat() clones, which handle Unix-style directory names */
540#define Stat(name,bufptr) flex_stat(name,bufptr)
fd8cd3a3 541#define Fstat(fd,bufptr) Perl_flex_fstat(aTHX_ fd,bufptr)
10d1eec1 542#ifndef DONT_MASK_RTL_CALLS
f1db9cda 543#define lstat(name, bufptr) flex_lstat(name, bufptr)
10d1eec1 544#endif
a0d0e21e
LW
545
546/* Setup for the dirent routines:
547 * opendir(), closedir(), readdir(), seekdir(), telldir(), and
548 * vmsreaddirversions(), and preprocessor stuff on which these depend:
549 * Written by Rich $alz, <rsalz@bbn.com> in August, 1990.
2497a41f 550 *
a0d0e21e 551 */
2497a41f 552
657054d4
JM
553/* Flags for the _dirdesc structure */
554#define PERL_VMSDIR_M_VERSIONS 0x02 /* Want VMS versions */
555#define PERL_VMSDIR_M_UNIXSPECS 0x04 /* Want UNIX specifications */
556
557
a0d0e21e 558 /* Data structure returned by READDIR(). */
ddcbaa1c 559struct dirent {
a0d0e21e 560 char d_name[256]; /* File name */
2497a41f 561 int d_namlen; /* Length of d_name */
a0d0e21e
LW
562 int vms_verscount; /* Number of versions */
563 int vms_versions[20]; /* Version numbers */
564};
565
566 /* Handle returned by opendir(), used by the other routines. You
567 * are not supposed to care what's inside this structure. */
ddcbaa1c 568typedef struct _dirdesc {
a0d0e21e 569 long context;
657054d4 570 int flags;
a0d0e21e
LW
571 unsigned long int count;
572 char *pattern;
ddcbaa1c 573 struct dirent entry;
a0d0e21e 574 struct dsc$descriptor_s pat;
a9852f7c 575 void *mutex;
ddcbaa1c 576} DIR;
a0d0e21e 577
2497a41f 578
a0d0e21e
LW
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.
2497a41f
JM
614 *
615 * The simplest thing is to just put a wrapper around the stat structure
616 * supplied by the CRTL and use #defines to redirect references to the
617 * members to the real names.
748a9306 618 */
2497a41f 619
e0261ef8
CB
620#if defined(__DECC) || defined(__DECCXX)
621# pragma __member_alignment __save
622# pragma member_alignment
623#endif
624
2497a41f
JM
625typedef unsigned mydev_t;
626#ifndef _LARGEFILE
627typedef unsigned myino_t;
628#else
629typedef __ino64_t myino_t;
748a9306 630#endif
e0261ef8 631
748a9306
LW
632struct mystat
633{
2497a41f
JM
634 struct stat crtl_stat;
635 myino_t st_ino;
636#ifndef _LARGEFILE
637 unsigned rvn; /* FID (num,seq,rvn) + pad */
638#endif
639 mydev_t st_dev;
640 char st_devnam[256]; /* Cache the (short) VMS name */
748a9306 641};
e0261ef8 642
2497a41f
JM
643#define st_mode crtl_stat.st_mode
644#define st_nlink crtl_stat.st_nlink
645#define st_uid crtl_stat.st_uid
646#define st_gid crtl_stat.st_gid
647#define st_rdev crtl_stat.st_rdev
648#define st_size crtl_stat.st_size
649#define st_atime crtl_stat.st_atime
650#define st_mtime crtl_stat.st_mtime
651#define st_ctime crtl_stat.st_ctime
652#define st_fab_rfm crtl_stat.st_fab_rfm
653#define st_fab_rat crtl_stat.st_fab_rat
654#define st_fab_fsz crtl_stat.st_fab_fsz
682e4b71
JM
655#define st_fab_mrs crtl_stat.st_fab_mrs
656
657#ifdef _USE_STD_STAT
658#define VMS_INO_T_COMPARE(__a, __b) (__a != __b)
cfcfe586 659#define VMS_INO_T_COPY(__a, __b) __a = __b
682e4b71
JM
660#else
661#define VMS_INO_T_COMPARE(__a, __b) memcmp(&__a, &__b, 6)
662#define VMS_INO_T_COPY(__a, __b) memcpy(&__a, &__b, 6)
663#endif
e0261ef8 664
e0261ef8
CB
665#if defined(__DECC) || defined(__DECCXX)
666# pragma __member_alignment __restore
667#endif
668
aa689395
PP
669#ifndef DONT_MASK_RTL_CALLS /* defined for vms.c so we can see RTL calls */
670# ifdef stat
671# undef stat
672# endif
673# define stat mystat
674# define dev_t mydev_t
675# define ino_t myino_t
676#endif
748a9306
LW
677/* Cons up a 'delete' bit for testing access */
678#define S_IDUSR (S_IWUSR | S_IXUSR)
679#define S_IDGRP (S_IWGRP | S_IXGRP)
680#define S_IDOTH (S_IWOTH | S_IXOTH)
a0d0e21e 681
a44ceb8e 682
f9fd8397 683#ifndef PERL_FOR_X2P
a0d0e21e
LW
684/* Prototypes for functions unique to vms.c. Don't include replacements
685 * for routines in the mainline source files excluded by #ifndef VMS;
686 * their prototypes are already in proto.h.
a0d0e21e 687 */
94c456c4 688
929df5ff
CB
689#ifdef __cplusplus
690extern "C" {
691#endif
692
20ce7b12 693void prime_env_iter (void);
2fbb330f 694void init_os_extras (void);
7a7fd8e0
JM
695int Perl_vms_status_to_unix(int vms_status, int child_flag);
696int Perl_unix_status_to_vms(int unix_status);
fd8cd3a3 697int Perl_vmstrnenv (const char *, char *, unsigned long int, struct dsc$descriptor_s **, unsigned long int);
360732b5 698char * Perl_vms_realpath (pTHX_ const char *, char *, int *);
5c84aa53 699char * Perl_my_getenv (pTHX_ const char *, bool);
4b19af01 700int Perl_my_trnlnm (pTHX_ const char *, char *, unsigned long int);
b8ffc8df
RGS
701char * Perl_tounixspec (pTHX_ const char *, char *);
702char * Perl_tounixspec_ts (pTHX_ const char *, char *);
360732b5
JM
703char * Perl_tounixspec_utf8 (pTHX_ const char *, char *, int *);
704char * Perl_tounixspec_utf8_ts (pTHX_ const char *, char *, int *);
2fbb330f
JM
705char * Perl_tovmsspec (pTHX_ const char *, char *);
706char * Perl_tovmsspec_ts (pTHX_ const char *, char *);
360732b5
JM
707char * Perl_tovmsspec_utf8 (pTHX_ const char *, char *, int *);
708char * Perl_tovmsspec_utf8_ts (pTHX_ const char *, char *, int *);
b8ffc8df
RGS
709char * Perl_tounixpath (pTHX_ const char *, char *);
710char * Perl_tounixpath_ts (pTHX_ const char *, char *);
360732b5
JM
711char * Perl_tounixpath_utf8 (pTHX_ const char *, char *, int *);
712char * Perl_tounixpath_utf8_ts (pTHX_ const char *, char *, int *);
b8ffc8df
RGS
713char * Perl_tovmspath (pTHX_ const char *, char *);
714char * Perl_tovmspath_ts (pTHX_ const char *, char *);
360732b5
JM
715char * Perl_tovmspath_utf8 (pTHX_ const char *, char *, int *);
716char * Perl_tovmspath_utf8_ts (pTHX_ const char *, char *, int *);
b8ffc8df
RGS
717int Perl_do_rmdir (pTHX_ const char *);
718char * Perl_fileify_dirspec (pTHX_ const char *, char *);
719char * Perl_fileify_dirspec_ts (pTHX_ const char *, char *);
360732b5
JM
720char * Perl_fileify_dirspec_utf8 (pTHX_ const char *, char *, int *);
721char * Perl_fileify_dirspec_utf8_ts (pTHX_ const char *, char *, int *);
b8ffc8df
RGS
722char * Perl_pathify_dirspec (pTHX_ const char *, char *);
723char * Perl_pathify_dirspec_ts (pTHX_ const char *, char *);
360732b5
JM
724char * Perl_pathify_dirspec_utf8 (pTHX_ const char *, char *, int *);
725char * Perl_pathify_dirspec_utf8_ts (pTHX_ const char *, char *, int *);
2fbb330f
JM
726char * Perl_rmsexpand (pTHX_ const char *, char *, const char *, unsigned);
727char * Perl_rmsexpand_ts (pTHX_ const char *, char *, const char *, unsigned);
360732b5
JM
728char * Perl_rmsexpand_utf8 (pTHX_ const char *, char *, const char *, unsigned, int *, int *);
729char * Perl_rmsexpand_utf8_ts (pTHX_ const char *, char *, const char *, unsigned, int *, int *);
2fbb330f 730int Perl_trim_unixpath (pTHX_ char *, const char*, int);
ddcbaa1c 731DIR * Perl_opendir (pTHX_ const char *);
4fdf8f88 732int Perl_rename (pTHX_ const char *, const char *);
2fbb330f 733int Perl_rmscopy (pTHX_ const char *, const char *, int);
b8ffc8df 734int Perl_my_mkdir (pTHX_ const char *, Mode_t);
fd8cd3a3 735bool Perl_vms_do_aexec (pTHX_ SV *, SV **, SV **);
2497a41f 736int Perl_vms_case_tolerant(void);
fd8cd3a3 737char * Perl_my_getenv_len (pTHX_ const char *, unsigned long *, bool);
2c590a56 738int Perl_vmssetenv (pTHX_ const char *, const char *, struct dsc$descriptor_s **);
0db50132 739void Perl_vmssetuserlnm(const char *name, const char *eqv);
fd8cd3a3
DS
740char * Perl_my_crypt (pTHX_ const char *, const char *);
741Pid_t Perl_my_waitpid (pTHX_ Pid_t, int *, int);
20ce7b12 742char * my_gconvert (double, int, int, char *);
b8ffc8df
RGS
743int Perl_kill_file (pTHX_ const char *);
744int Perl_my_chdir (pTHX_ const char *);
f1db9cda 745int Perl_my_chmod(pTHX_ const char *, mode_t);
2fbb330f 746FILE * Perl_my_tmpfile (void);
5c2d7af2 747int Perl_my_sigaction (pTHX_ int, const struct sigaction*, struct sigaction*);
f2610a60 748#ifdef KILL_BY_SIGPRC
2e34cc90 749unsigned int Perl_sig_to_vmscondition (int);
f2610a60 750int Perl_my_kill (int, int);
2e34cc90 751void Perl_csighandler_init (void);
f2610a60 752#endif
94a11853 753int Perl_my_utime (pTHX_ const char *, const struct utimbuf *);
fd8cd3a3 754void Perl_vms_image_init (int *, char ***);
ddcbaa1c
CB
755struct dirent * Perl_readdir (pTHX_ DIR *);
756int Perl_readdir_r(pTHX_ DIR *, struct dirent *, struct dirent **);
757long Perl_telldir (DIR *);
758void Perl_seekdir (pTHX_ DIR *, long);
759void Perl_closedir (DIR *);
760void vmsreaddirversions (DIR *, int);
fd8cd3a3
DS
761struct tm * Perl_my_gmtime (pTHX_ const time_t *);
762struct tm * Perl_my_localtime (pTHX_ const time_t *);
763time_t Perl_my_time (pTHX_ time_t *);
03e3cfa3 764I32 Perl_cando_by_name (pTHX_ I32, bool, const char *);
fd8cd3a3 765int Perl_flex_fstat (pTHX_ int, Stat_t *);
2497a41f 766int Perl_flex_lstat (pTHX_ const char *, Stat_t *);
fd8cd3a3 767int Perl_flex_stat (pTHX_ const char *, Stat_t *);
2fbb330f
JM
768int my_vfork (void);
769bool Perl_vms_do_exec (pTHX_ const char *);
0dac06c4 770FILE * my_fdopen (int, const char *);
bc10a425 771int my_fclose (FILE *);
2ee6e19d 772int my_fwrite (const void *, size_t, size_t, FILE *);
bf8d1304 773char * Perl_my_fgetname (FILE *fp, char *buf);
2ee6e19d 774#ifdef HAS_SYMLINK
4148925f 775int Perl_my_symlink(pTHX_ const char *path1, const char *path2);
2ee6e19d 776#endif
fd8cd3a3 777int Perl_my_flush (pTHX_ FILE *);
2fbb330f 778struct passwd * Perl_my_getpwnam (pTHX_ const char *name);
fd8cd3a3 779struct passwd * Perl_my_getpwuid (pTHX_ Uid_t uid);
9fa802f3 780void Perl_my_endpwent (pTHX);
2fbb330f 781char * my_getlogin (void);
929df5ff
CB
782
783#ifdef __cplusplus
784}
785#endif
786
44a8e56a
PP
787#endif
788
a0d0e21e 789#ifndef VMS_DO_SOCKETS
748a9306
LW
790/* This relies on tricks in perl.h to pick up that these manifest constants
791 * are undefined and set up conversion routines. It will then redefine
792 * these manifest constants, so the actual values will match config.h
793 */
794#undef HAS_HTONS
795#undef HAS_NTOHS
796#undef HAS_HTONL
797#undef HAS_NTOHL
a0d0e21e
LW
798#endif
799
3b7650f4
CB
800/* The C RTL manual says to undef the macro for DEC C 5.2 and lower. */
801#if defined(fileno) && defined(__DECC_VER) && __DECC_VER < 50300000
802# undef fileno
803#endif
804
22d4bb9c
CB
805#define NO_ENVIRON_ARRAY
806
e886094b
JM
807/* RMSEXPAND options */
808#define PERL_RMSEXPAND_M_VMS 0x02 /* Force output to VMS format */
809#define PERL_RMSEXPAND_M_LONG 0x04 /* Expand to long name format */
a1887106 810#define PERL_RMSEXPAND_M_VMS_IN 0x08 /* Assume input is VMS already */
e886094b
JM
811#define PERL_RMSEXPAND_M_SYMLINK 0x20 /* Use symbolic link, not target */
812
a0d0e21e 813#endif /* __vmsish_h_included */