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